elementary/naviframe - removed unused APIs
[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 graphmes */
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     * @typedef Elm_Object_Item
333     * An Elementary Object item handle.
334     * @ingroup General
335     */
336    typedef struct _Elm_Object_Item Elm_Object_Item;
337
338
339    /**
340     * Called back when a widget's tooltip is activated and needs content.
341     * @param data user-data given to elm_object_tooltip_content_cb_set()
342     * @param obj owner widget.
343     */
344    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
345
346    /**
347     * Called back when a widget's item tooltip is activated and needs content.
348     * @param data user-data given to elm_object_tooltip_content_cb_set()
349     * @param obj owner widget.
350     * @param item context dependent item. As an example, if tooltip was
351     *        set on Elm_List_Item, then it is of this type.
352     */
353    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
354
355    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
356
357 #ifndef ELM_LIB_QUICKLAUNCH
358 #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 */
359 #else
360 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
361 #endif
362
363 /**************************************************************************/
364    /* General calls */
365
366    /**
367     * Initialize Elementary
368     *
369     * @param[in] argc System's argument count value
370     * @param[in] argv System's pointer to array of argument strings
371     * @return The init counter value.
372     *
373     * This function initializes Elementary and increments a counter of
374     * the number of calls to it. It returs the new counter's value.
375     *
376     * @warning This call is exported only for use by the @c ELM_MAIN()
377     * macro. There is no need to use this if you use this macro (which
378     * is highly advisable). An elm_main() should contain the entry
379     * point code for your application, having the same prototype as
380     * elm_init(), and @b not being static (putting the @c EAPI symbol
381     * in front of its type declaration is advisable). The @c
382     * ELM_MAIN() call should be placed just after it.
383     *
384     * Example:
385     * @dontinclude bg_example_01.c
386     * @skip static void
387     * @until ELM_MAIN
388     *
389     * See the full @ref bg_example_01_c "example".
390     *
391     * @see elm_shutdown().
392     * @ingroup General
393     */
394    EAPI int          elm_init(int argc, char **argv);
395
396    /**
397     * Shut down Elementary
398     *
399     * @return The init counter value.
400     *
401     * This should be called at the end of your application, just
402     * before it ceases to do any more processing. This will clean up
403     * any permanent resources your application may have allocated via
404     * Elementary that would otherwise persist.
405     *
406     * @see elm_init() for an example
407     *
408     * @ingroup General
409     */
410    EAPI int          elm_shutdown(void);
411
412    /**
413     * Run Elementary's main loop
414     *
415     * This call should be issued just after all initialization is
416     * completed. This function will not return until elm_exit() is
417     * called. It will keep looping, running the main
418     * (event/processing) loop for Elementary.
419     *
420     * @see elm_init() for an example
421     *
422     * @ingroup General
423     */
424    EAPI void         elm_run(void);
425
426    /**
427     * Exit Elementary's main loop
428     *
429     * If this call is issued, it will flag the main loop to cease
430     * processing and return back to its parent function (usually your
431     * elm_main() function).
432     *
433     * @see elm_init() for an example. There, just after a request to
434     * close the window comes, the main loop will be left.
435     *
436     * @note By using the #ELM_POLICY_QUIT on your Elementary
437     * applications, you'll this function called automatically for you.
438     *
439     * @ingroup General
440     */
441    EAPI void         elm_exit(void);
442
443    /**
444     * Provide information in order to make Elementary determine the @b
445     * run time location of the software in question, so other data files
446     * such as images, sound files, executable utilities, libraries,
447     * modules and locale files can be found.
448     *
449     * @param mainfunc This is your application's main function name,
450     *        whose binary's location is to be found. Providing @c NULL
451     *        will make Elementary not to use it
452     * @param dom This will be used as the application's "domain", in the
453     *        form of a prefix to any environment variables that may
454     *        override prefix detection and the directory name, inside the
455     *        standard share or data directories, where the software's
456     *        data files will be looked for.
457     * @param checkfile This is an (optional) magic file's path to check
458     *        for existence (and it must be located in the data directory,
459     *        under the share directory provided above). Its presence will
460     *        help determine the prefix found was correct. Pass @c NULL if
461     *        the check is not to be done.
462     *
463     * This function allows one to re-locate the application somewhere
464     * else after compilation, if the developer wishes for easier
465     * distribution of pre-compiled binaries.
466     *
467     * The prefix system is designed to locate where the given software is
468     * installed (under a common path prefix) at run time and then report
469     * specific locations of this prefix and common directories inside
470     * this prefix like the binary, library, data and locale directories,
471     * through the @c elm_app_*_get() family of functions.
472     *
473     * Call elm_app_info_set() early on before you change working
474     * directory or anything about @c argv[0], so it gets accurate
475     * information.
476     *
477     * It will then try and trace back which file @p mainfunc comes from,
478     * if provided, to determine the application's prefix directory.
479     *
480     * The @p dom parameter provides a string prefix to prepend before
481     * environment variables, allowing a fallback to @b specific
482     * environment variables to locate the software. You would most
483     * probably provide a lowercase string there, because it will also
484     * serve as directory domain, explained next. For environment
485     * variables purposes, this string is made uppercase. For example if
486     * @c "myapp" is provided as the prefix, then the program would expect
487     * @c "MYAPP_PREFIX" as a master environment variable to specify the
488     * exact install prefix for the software, or more specific environment
489     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
490     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
491     * the user or scripts before launching. If not provided (@c NULL),
492     * environment variables will not be used to override compiled-in
493     * defaults or auto detections.
494     *
495     * The @p dom string also provides a subdirectory inside the system
496     * shared data directory for data files. For example, if the system
497     * directory is @c /usr/local/share, then this directory name is
498     * appended, creating @c /usr/local/share/myapp, if it @p was @c
499     * "myapp". It is expected the application installs data files in
500     * this directory.
501     *
502     * The @p checkfile is a file name or path of something inside the
503     * share or data directory to be used to test that the prefix
504     * detection worked. For example, your app will install a wallpaper
505     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
506     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
507     * checkfile string.
508     *
509     * @see elm_app_compile_bin_dir_set()
510     * @see elm_app_compile_lib_dir_set()
511     * @see elm_app_compile_data_dir_set()
512     * @see elm_app_compile_locale_set()
513     * @see elm_app_prefix_dir_get()
514     * @see elm_app_bin_dir_get()
515     * @see elm_app_lib_dir_get()
516     * @see elm_app_data_dir_get()
517     * @see elm_app_locale_dir_get()
518     */
519    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
520
521    /**
522     * Provide information on the @b fallback application's binaries
523     * directory, on scenarios where they get overriden by
524     * elm_app_info_set().
525     *
526     * @param dir The path to the default binaries directory (compile time
527     * one)
528     *
529     * @note Elementary will as well use this path to determine actual
530     * names of binaries' directory paths, maybe changing it to be @c
531     * something/local/bin instead of @c something/bin, only, for
532     * example.
533     *
534     * @warning You should call this function @b before
535     * elm_app_info_set().
536     */
537    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
538
539    /**
540     * Provide information on the @b fallback application's libraries
541     * directory, on scenarios where they get overriden by
542     * elm_app_info_set().
543     *
544     * @param dir The path to the default libraries directory (compile
545     * time one)
546     *
547     * @note Elementary will as well use this path to determine actual
548     * names of libraries' directory paths, maybe changing it to be @c
549     * something/lib32 or @c something/lib64 instead of @c something/lib,
550     * only, for example.
551     *
552     * @warning You should call this function @b before
553     * elm_app_info_set().
554     */
555    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
556
557    /**
558     * Provide information on the @b fallback application's data
559     * directory, on scenarios where they get overriden by
560     * elm_app_info_set().
561     *
562     * @param dir The path to the default data directory (compile time
563     * one)
564     *
565     * @note Elementary will as well use this path to determine actual
566     * names of data directory paths, maybe changing it to be @c
567     * something/local/share instead of @c something/share, only, for
568     * example.
569     *
570     * @warning You should call this function @b before
571     * elm_app_info_set().
572     */
573    EAPI void         elm_app_compile_data_dir_set(const char *dir);
574
575    /**
576     * Provide information on the @b fallback application's locale
577     * directory, on scenarios where they get overriden by
578     * elm_app_info_set().
579     *
580     * @param dir The path to the default locale directory (compile time
581     * one)
582     *
583     * @warning You should call this function @b before
584     * elm_app_info_set().
585     */
586    EAPI void         elm_app_compile_locale_set(const char *dir);
587
588    /**
589     * Retrieve the application's run time prefix directory, as set by
590     * elm_app_info_set() and the way (environment) the application was
591     * run from.
592     *
593     * @return The directory prefix the application is actually using
594     */
595    EAPI const char  *elm_app_prefix_dir_get(void);
596
597    /**
598     * Retrieve the application's run time binaries prefix directory, as
599     * set by elm_app_info_set() and the way (environment) the application
600     * was run from.
601     *
602     * @return The binaries directory prefix the application is actually
603     * using
604     */
605    EAPI const char  *elm_app_bin_dir_get(void);
606
607    /**
608     * Retrieve the application's run time libraries prefix directory, as
609     * set by elm_app_info_set() and the way (environment) the application
610     * was run from.
611     *
612     * @return The libraries directory prefix the application is actually
613     * using
614     */
615    EAPI const char  *elm_app_lib_dir_get(void);
616
617    /**
618     * Retrieve the application's run time data prefix directory, as
619     * set by elm_app_info_set() and the way (environment) the application
620     * was run from.
621     *
622     * @return The data directory prefix the application is actually
623     * using
624     */
625    EAPI const char  *elm_app_data_dir_get(void);
626
627    /**
628     * Retrieve the application's run time locale prefix directory, as
629     * set by elm_app_info_set() and the way (environment) the application
630     * was run from.
631     *
632     * @return The locale directory prefix the application is actually
633     * using
634     */
635    EAPI const char  *elm_app_locale_dir_get(void);
636
637    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
638    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
639    EAPI int          elm_quicklaunch_init(int argc, char **argv);
640    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
641    EAPI int          elm_quicklaunch_sub_shutdown(void);
642    EAPI int          elm_quicklaunch_shutdown(void);
643    EAPI void         elm_quicklaunch_seed(void);
644    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
645    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
646    EAPI void         elm_quicklaunch_cleanup(void);
647    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
648    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
649
650    EAPI Eina_Bool    elm_need_efreet(void);
651    EAPI Eina_Bool    elm_need_e_dbus(void);
652    EAPI Eina_Bool    elm_need_ethumb(void);
653
654    /**
655     * Set a new policy's value (for a given policy group/identifier).
656     *
657     * @param policy policy identifier, as in @ref Elm_Policy.
658     * @param value policy value, which depends on the identifier
659     *
660     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
661     *
662     * Elementary policies define applications' behavior,
663     * somehow. These behaviors are divided in policy groups (see
664     * #Elm_Policy enumeration). This call will emit the Ecore event
665     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
666     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
667     * then.
668     *
669     * @note Currently, we have only one policy identifier/group
670     * (#ELM_POLICY_QUIT), which has two possible values.
671     *
672     * @ingroup General
673     */
674    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
675
676    /**
677     * Gets the policy value set for given policy identifier.
678     *
679     * @param policy policy identifier, as in #Elm_Policy.
680     * @return The currently set policy value, for that
681     * identifier. Will be @c 0 if @p policy passed is invalid.
682     *
683     * @ingroup General
684     */
685    EAPI int          elm_policy_get(unsigned int policy);
686
687    /**
688     * Set a label of an object
689     *
690     * @param obj The Elementary object
691     * @param part The text part name to set (NULL for the default label)
692     * @param label The new text of the label
693     *
694     * @note Elementary objects may have many labels (e.g. Action Slider)
695     *
696     * @ingroup General
697     */
698    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
699
700 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
701
702    /**
703     * Get a label of an object
704     *
705     * @param obj The Elementary object
706     * @param part The text part name to get (NULL for the default label)
707     * @return text of the label or NULL for any error
708     *
709     * @note Elementary objects may have many labels (e.g. Action Slider)
710     *
711     * @ingroup General
712     */
713    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
714
715 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
716
717    /**
718     * Set a content of an object
719     *
720     * @param obj The Elementary object
721     * @param part The content part name to set (NULL for the default content)
722     * @param content The new content of the object
723     *
724     * @note Elementary objects may have many contents
725     *
726     * @ingroup General
727     */
728    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
729
730 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
731
732    /**
733     * Get a content of an object
734     *
735     * @param obj The Elementary object
736     * @param item The content part name to get (NULL for the default content)
737     * @return content of the object or NULL for any error
738     *
739     * @note Elementary objects may have many contents
740     *
741     * @ingroup General
742     */
743    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
744
745 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
746
747    /**
748     * Unset a content of an object
749     *
750     * @param obj The Elementary object
751     * @param item The content part name to unset (NULL for the default content)
752     *
753     * @note Elementary objects may have many contents
754     *
755     * @ingroup General
756     */
757    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
758
759 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
760
761    /**
762     * Set a content of an object item
763     *
764     * @param it The Elementary object item
765     * @param part The content part name to set (NULL for the default content)
766     * @param content The new content of the object item
767     *
768     * @note Elementary object items may have many contents
769     *
770     * @ingroup General
771     */
772    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
773
774 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
775
776    /**
777     * Get a content of an object item
778     *
779     * @param it The Elementary object item
780     * @param part The content part name to unset (NULL for the default content)
781     * @return content of the object item or NULL for any error
782     *
783     * @note Elementary object items may have many contents
784     *
785     * @ingroup General
786     */
787    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
788
789 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
790
791    /**
792     * Unset a content of an object item
793     *
794     * @param it The Elementary object item
795     * @param part The content part name to unset (NULL for the default content)
796     *
797     * @note Elementary object items may have many contents
798     *
799     * @ingroup General
800     */
801    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
802
803 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
804
805    /**
806     * Set a label of an objec itemt
807     *
808     * @param it The Elementary object item
809     * @param part The text part name to set (NULL for the default label)
810     * @param label The new text of the label
811     *
812     * @note Elementary object items may have many labels
813     *
814     * @ingroup General
815     */
816    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
817
818 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
819
820    /**
821     * Get a label of an object
822     *
823     * @param it The Elementary object item
824     * @param part The text part name to get (NULL for the default label)
825     * @return text of the label or NULL for any error
826     *
827     * @note Elementary object items may have many labels
828     *
829     * @ingroup General
830     */
831    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
832
833    /**
834     * Set the text to read out when in accessibility mode
835     *
836     * @param obj The object which is to be described
837     * @param txt The text that describes the widget to people with poor or no vision
838     *
839     * @ingroup General
840     */
841    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
842
843    /**
844     * Set the text to read out when in accessibility mode
845     *
846     * @param it The object item which is to be described
847     * @param txt The text that describes the widget to people with poor or no vision
848     *
849     * @ingroup General
850     */
851    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
852
853
854 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
855
856    /**
857     * Get the data associated with an object item
858     * @param it The object item
859     * @return The data associated with @p it
860     *
861     * @ingroup General
862     */
863    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
864
865    /**
866     * Set the data associated with an object item
867     * @param it The object item
868     * @param data The data to be associated with @p it
869     *
870     * @ingroup General
871     */
872    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
873
874    /**
875     * @}
876     */
877
878    EAPI void         elm_all_flush(void);
879    EAPI int          elm_cache_flush_interval_get(void);
880    EAPI void         elm_cache_flush_interval_set(int size);
881    EAPI void         elm_cache_flush_interval_all_set(int size);
882    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
883    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
884    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
885    EAPI int          elm_font_cache_get(void);
886    EAPI void         elm_font_cache_set(int size);
887    EAPI void         elm_font_cache_all_set(int size);
888    EAPI int          elm_image_cache_get(void);
889    EAPI void         elm_image_cache_set(int size);
890    EAPI void         elm_image_cache_all_set(int size);
891    EAPI int          elm_edje_file_cache_get(void);
892    EAPI void         elm_edje_file_cache_set(int size);
893    EAPI void         elm_edje_file_cache_all_set(int size);
894    EAPI int          elm_edje_collection_cache_get(void);
895    EAPI void         elm_edje_collection_cache_set(int size);
896    EAPI void         elm_edje_collection_cache_all_set(int size);
897
898    /**
899     * @defgroup Scaling Selective Widget Scaling
900     *
901     * Different widgets can be scaled independently. These functions
902     * allow you to manipulate this scaling on a per-widget basis. The
903     * object and all its children get their scaling factors multiplied
904     * by the scale factor set. This is multiplicative, in that if a
905     * child also has a scale size set it is in turn multiplied by its
906     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
907     * double size, @c 0.5 is half, etc.
908     *
909     * @ref general_functions_example_page "This" example contemplates
910     * some of these functions.
911     */
912
913    /**
914     * Set the scaling factor for a given Elementary object
915     *
916     * @param obj The Elementary to operate on
917     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
918     * no scaling)
919     *
920     * @ingroup Scaling
921     */
922    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
923
924    /**
925     * Get the scaling factor for a given Elementary object
926     *
927     * @param obj The object
928     * @return The scaling factor set by elm_object_scale_set()
929     *
930     * @ingroup Scaling
931     */
932    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
933
934    /**
935     * @defgroup Password_last_show Password last input show
936     *
937     * Last show feature of password mode enables user to view
938     * the last input entered for few seconds before masking it.
939     * These functions allow to set this feature in password mode
940     * of entry widget and also allow to manipulate the duration 
941     * for which the input has to be visible.
942     *
943     * @{
944     */
945
946    /**
947     * Get show last setting of password mode.
948     *
949     * This gets the show last input setting of password mode which might be 
950     * enabled or disabled.
951     *
952     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
953     *            if it's disabled.
954     * @ingroup Password_last_show
955     */
956    EAPI Eina_Bool elm_password_show_last_get(void);
957
958    /**
959     * Set show last setting in password mode.
960     *
961     * This enables or disables show last setting of password mode.
962     *
963     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
964     * @see elm_password_show_last_timeout_set()
965     * @ingroup Password_last_show
966     */
967    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
968
969    /**
970     * Get's the timeout value in last show password mode.
971     *
972     * This gets the time out value for which the last input entered in password
973     * mode will be visible.
974     *
975     * @return The timeout value of last show password mode.
976     * @ingroup Password_last_show
977     */
978    EAPI double elm_password_show_last_timeout_get(void);
979
980    /**
981     * Set's the timeout value in last show password mode.
982     *
983     * This sets the time out value for which the last input entered in password
984     * mode will be visible.
985     *
986     * @param password_show_last_timeout The timeout value.
987     * @see elm_password_show_last_set()
988     * @ingroup Password_last_show
989     */
990    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
991
992    /**
993     * @}
994     */
995
996    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
997    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
998    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
999    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1000    /**
1001     * Set the style to use by a widget
1002     *
1003     * Sets the style name that will define the appearance of a widget. Styles
1004     * vary from widget to widget and may also be defined by other themes
1005     * by means of extensions and overlays.
1006     *
1007     * @param obj The Elementary widget to style
1008     * @param style The style name to use
1009     *
1010     * @see elm_theme_extension_add()
1011     * @see elm_theme_overlay_add()
1012     *
1013     * @ingroup Theme
1014     */
1015    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1016    /**
1017     * Get the style used by the widget
1018     *
1019     * This gets the style being used for that widget. Note that the string
1020     * pointer is only valid as longas the object is valid and the style doesn't
1021     * change.
1022     *
1023     * @param obj The Elementary widget to query for its style
1024     * @return The style name used
1025     *
1026     * @see elm_object_style_set()
1027     *
1028     * @ingroup Theme
1029     */
1030    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1031
1032    /**
1033     * @defgroup Styles Styles
1034     *
1035     * Widgets can have different styles of look. These generic API's
1036     * set styles of widgets, if they support them (and if the theme(s)
1037     * do).
1038     *
1039     * @ref general_functions_example_page "This" example contemplates
1040     * some of these functions.
1041     */
1042
1043    /**
1044     * Set the disabled state of an Elementary object.
1045     *
1046     * @param obj The Elementary object to operate on
1047     * @param disabled The state to put in in: @c EINA_TRUE for
1048     *        disabled, @c EINA_FALSE for enabled
1049     *
1050     * Elementary objects can be @b disabled, in which state they won't
1051     * receive input and, in general, will be themed differently from
1052     * their normal state, usually greyed out. Useful for contexts
1053     * where you don't want your users to interact with some of the
1054     * parts of you interface.
1055     *
1056     * This sets the state for the widget, either disabling it or
1057     * enabling it back.
1058     *
1059     * @ingroup Styles
1060     */
1061    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1062
1063    /**
1064     * Get the disabled state of an Elementary object.
1065     *
1066     * @param obj The Elementary object to operate on
1067     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1068     *            if it's enabled (or on errors)
1069     *
1070     * This gets the state of the widget, which might be enabled or disabled.
1071     *
1072     * @ingroup Styles
1073     */
1074    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1075
1076    /**
1077     * @defgroup WidgetNavigation Widget Tree Navigation.
1078     *
1079     * How to check if an Evas Object is an Elementary widget? How to
1080     * get the first elementary widget that is parent of the given
1081     * object?  These are all covered in widget tree navigation.
1082     *
1083     * @ref general_functions_example_page "This" example contemplates
1084     * some of these functions.
1085     */
1086
1087    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1088
1089    /**
1090     * Get the first parent of the given object that is an Elementary
1091     * widget.
1092     *
1093     * @param obj the Elementary object to query parent from.
1094     * @return the parent object that is an Elementary widget, or @c
1095     *         NULL, if it was not found.
1096     *
1097     * Use this to query for an object's parent widget.
1098     *
1099     * @note Most of Elementary users wouldn't be mixing non-Elementary
1100     * smart objects in the objects tree of an application, as this is
1101     * an advanced usage of Elementary with Evas. So, except for the
1102     * application's window, which is the root of that tree, all other
1103     * objects would have valid Elementary widget parents.
1104     *
1105     * @ingroup WidgetNavigation
1106     */
1107    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1108    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1109    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1110
1111    EAPI double       elm_scale_get(void);
1112    EAPI void         elm_scale_set(double scale);
1113    EAPI void         elm_scale_all_set(double scale);
1114
1115    EAPI Eina_Bool    elm_mirrored_get(void);
1116    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1117
1118    EAPI Eina_Bool    elm_config_save(void);
1119    EAPI void         elm_config_reload(void);
1120
1121    EAPI const char  *elm_profile_current_get(void);
1122    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1123    EAPI void         elm_profile_dir_free(const char *p_dir);
1124    EAPI Eina_List   *elm_profile_list_get(void);
1125    EAPI void         elm_profile_list_free(Eina_List *l);
1126    EAPI void         elm_profile_set(const char *profile);
1127    EAPI void         elm_profile_all_set(const char *profile);
1128
1129    EAPI const char  *elm_engine_current_get(void);
1130    EAPI void         elm_engine_set(const char *engine);
1131
1132   typedef struct _Elm_Text_Class
1133     {
1134        const char *name;
1135        const char *desc;
1136     } Elm_Text_Class;
1137
1138   typedef struct _Elm_Font_Overlay
1139     {
1140        const char     *text_class;
1141        const char     *font;
1142        Evas_Font_Size  size;
1143     } Elm_Font_Overlay;
1144
1145   typedef struct _Elm_Font_Properties
1146     {
1147        const char *name;
1148        Eina_List  *styles;
1149     } Elm_Font_Properties;
1150
1151    EAPI const Eina_List     *elm_text_classes_list_get(void);
1152    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1153
1154    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1155    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1156    EAPI void                 elm_font_overlay_unset(const char *text_class);
1157    EAPI void                 elm_font_overlay_apply(void);
1158    EAPI void                 elm_font_overlay_all_apply(void);
1159
1160    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1161    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1162    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1163    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1164    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
1165    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
1166
1167    /**
1168     * @defgroup Fingers Fingers
1169     *
1170     * Elementary is designed to be finger-friendly for touchscreens,
1171     * and so in addition to scaling for display resolution, it can
1172     * also scale based on finger "resolution" (or size). You can then
1173     * customize the granularity of the areas meant to receive clicks
1174     * on touchscreens.
1175     *
1176     * Different profiles may have pre-set values for finger sizes.
1177     *
1178     * @ref general_functions_example_page "This" example contemplates
1179     * some of these functions.
1180     */
1181
1182    /**
1183     * Get the configured "finger size"
1184     *
1185     * @return The finger size
1186     *
1187     * This gets the globally configured finger size, <b>in pixels</b>
1188     *
1189     * @ingroup Fingers
1190     */
1191    EAPI Evas_Coord       elm_finger_size_get(void);
1192    EAPI void             elm_finger_size_set(Evas_Coord size);
1193    EAPI void             elm_finger_size_all_set(Evas_Coord size);
1194
1195    /**
1196     * @defgroup Focus Focus
1197     *
1198     * An Elementary application has, at all times, one (and only one)
1199     * @b focused object. This is what determines where the input
1200     * events go to within the application's window. Also, focused
1201     * objects can be decorated differently, in order to signal to the
1202     * user where the input is, at a given moment.
1203     *
1204     * Elementary applications also have the concept of <b>focus
1205     * chain</b>: one can cycle through all the windows' focusable
1206     * objects by input (tab key) or programmatically. The default
1207     * focus chain for an application is the one define by the order in
1208     * which the widgets where added in code. One will cycle through
1209     * top level widgets, and, for each one containg sub-objects, cycle
1210     * through them all, before returning to the level
1211     * above. Elementary also allows one to set @b custom focus chains
1212     * for their applications.
1213     *
1214     * Besides the focused decoration a widget may exhibit, when it
1215     * gets focus, Elementary has a @b global focus highlight object
1216     * that can be enabled for a window. If one chooses to do so, this
1217     * extra highlight effect will surround the current focused object,
1218     * too.
1219     *
1220     * @note Some Elementary widgets are @b unfocusable, after
1221     * creation, by their very nature: they are not meant to be
1222     * interacted with input events, but are there just for visual
1223     * purposes.
1224     *
1225     * @ref general_functions_example_page "This" example contemplates
1226     * some of these functions.
1227     */
1228
1229    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
1230    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
1231    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
1232    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
1233
1234    /**
1235     * Get the whether an Elementary object has the focus or not.
1236     *
1237     * @param obj The Elementary object to get the information from
1238     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1239     *            not (and on errors).
1240     *
1241     * @see elm_object_focus()
1242     *
1243     * @ingroup Focus
1244     */
1245    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1246
1247    /**
1248     * Make a given Elementary object the focused one.
1249     *
1250     * @param obj The Elementary object to make focused.
1251     *
1252     * @note This object, if it can handle focus, will take the focus
1253     * away from the one who had it previously and will, for now on, be
1254     * the one receiving input events.
1255     *
1256     * @see elm_object_focus_get()
1257     *
1258     * @ingroup Focus
1259     */
1260    EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1261
1262    /**
1263     * Remove the focus from an Elementary object
1264     *
1265     * @param obj The Elementary to take focus from
1266     *
1267     * This removes the focus from @p obj, passing it back to the
1268     * previous element in the focus chain list.
1269     *
1270     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1271     *
1272     * @ingroup Focus
1273     */
1274    EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1275
1276    /**
1277     * Set the ability for an Element object to be focused
1278     *
1279     * @param obj The Elementary object to operate on
1280     * @param enable @c EINA_TRUE if the object can be focused, @c
1281     *        EINA_FALSE if not (and on errors)
1282     *
1283     * This sets whether the object @p obj is able to take focus or
1284     * not. Unfocusable objects do nothing when programmatically
1285     * focused, being the nearest focusable parent object the one
1286     * really getting focus. Also, when they receive mouse input, they
1287     * will get the event, but not take away the focus from where it
1288     * was previously.
1289     *
1290     * @ingroup Focus
1291     */
1292    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1293
1294    /**
1295     * Get whether an Elementary object is focusable or not
1296     *
1297     * @param obj The Elementary object to operate on
1298     * @return @c EINA_TRUE if the object is allowed to be focused, @c
1299     *             EINA_FALSE if not (and on errors)
1300     *
1301     * @note Objects which are meant to be interacted with by input
1302     * events are created able to be focused, by default. All the
1303     * others are not.
1304     *
1305     * @ingroup Focus
1306     */
1307    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1308
1309    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1310    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1311    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1312    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1313    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1314    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1315    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1316
1317    /**
1318     * Make the elementary object and its children to be unfocusable (or focusable).
1319     *
1320     * @param obj The Elementary object to operate on
1321     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1322     *        @c EINA_FALSE for focusable.
1323     *
1324     * This sets whether the object @p obj and its children objects
1325     * able to take focus or not. If the tree is unfocusable,
1326     * newest focused object which is not in this tree will get focus.
1327     * This API can be helpful for an object to be deleted.
1328     * When an object will be deleted soon, it and its children may not
1329     * want to get focus (by focus reverting or by other focus controls).
1330     * Then, just use this API before deleting.
1331     *
1332     * @see elm_object_tree_unfocusable_get()
1333     *
1334     * @ingroup Focus
1335     */
1336    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1337
1338    /**
1339     * Get whether an Elementary object and its children are unfocusable or not.
1340     *
1341     * @param obj The Elementary object to get the information from
1342     * @return @c EINA_TRUE, if the tree is unfocussable,
1343     *         @c EINA_FALSE if not (and on errors).
1344     *
1345     * @see elm_object_tree_unfocusable_set()
1346     *
1347     * @ingroup Focus
1348     */
1349    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1350
1351    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
1352    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1353    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1354    EAPI double           elm_scroll_bounce_friction_get(void);
1355    EAPI void             elm_scroll_bounce_friction_set(double friction);
1356    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
1357    EAPI double           elm_scroll_page_scroll_friction_get(void);
1358    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
1359    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
1360    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
1361    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
1362    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
1363    EAPI double           elm_scroll_zoom_friction_get(void);
1364    EAPI void             elm_scroll_zoom_friction_set(double friction);
1365    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
1366    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
1367    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1368    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1369    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
1370    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1371    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1372    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
1373    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1374    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1375    EAPI double           elm_scroll_thumbscroll_friction_get(void);
1376    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
1377    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
1378    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
1379    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
1380    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
1381
1382    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1383    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1384    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1385    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1386    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1387    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1388    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1389    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1390
1391    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1392    EAPI void             elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data) EINA_ARG_NONNULL(1, 4);
1393    EAPI void            *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source)) EINA_ARG_NONNULL(1, 4);
1394
1395    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1396    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1397
1398    /**
1399     * Adjust size of an element for finger usage.
1400     *
1401     * @param times_w How many fingers should fit horizontally
1402     * @param w Pointer to the width size to adjust
1403     * @param times_h How many fingers should fit vertically
1404     * @param h Pointer to the height size to adjust
1405     *
1406     * This takes width and height sizes (in pixels) as input and a
1407     * size multiple (which is how many fingers you want to place
1408     * within the area, being "finger" the size set by
1409     * elm_finger_size_set()), and adjusts the size to be large enough
1410     * to accommodate the resulting size -- if it doesn't already
1411     * accommodate it. On return the @p w and @p h sizes pointed to by
1412     * these parameters will be modified, on those conditions.
1413     *
1414     * @note This is kind of a low level Elementary call, most useful
1415     * on size evaluation times for widgets. An external user wouldn't
1416     * be calling, most of the time.
1417     *
1418     * @ingroup Fingers
1419     */
1420    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1421
1422    EAPI double           elm_longpress_timeout_get(void);
1423    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
1424
1425    /* debug
1426     * don't use it unless you are sure
1427     */
1428    EAPI void             elm_object_tree_dump(const Evas_Object *top);
1429    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1430
1431    EAPI void             elm_autocapitalization_allow_all_set(Eina_Bool autocap);
1432    EAPI void             elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
1433
1434
1435    /* theme */
1436    /**
1437     * @defgroup Theme Theme
1438     *
1439     * Elementary uses Edje to theme its widgets, naturally. But for the most
1440     * part this is hidden behind a simpler interface that lets the user set
1441     * extensions and choose the style of widgets in a much easier way.
1442     *
1443     * Instead of thinking in terms of paths to Edje files and their groups
1444     * each time you want to change the appearance of a widget, Elementary
1445     * works so you can add any theme file with extensions or replace the
1446     * main theme at one point in the application, and then just set the style
1447     * of widgets with elm_object_style_set() and related functions. Elementary
1448     * will then look in its list of themes for a matching group and apply it,
1449     * and when the theme changes midway through the application, all widgets
1450     * will be updated accordingly.
1451     *
1452     * There are three concepts you need to know to understand how Elementary
1453     * theming works: default theme, extensions and overlays.
1454     *
1455     * Default theme, obviously enough, is the one that provides the default
1456     * look of all widgets. End users can change the theme used by Elementary
1457     * by setting the @c ELM_THEME environment variable before running an
1458     * application, or globally for all programs using the @c elementary_config
1459     * utility. Applications can change the default theme using elm_theme_set(),
1460     * but this can go against the user wishes, so it's not an adviced practice.
1461     *
1462     * Ideally, applications should find everything they need in the already
1463     * provided theme, but there may be occasions when that's not enough and
1464     * custom styles are required to correctly express the idea. For this
1465     * cases, Elementary has extensions.
1466     *
1467     * Extensions allow the application developer to write styles of its own
1468     * to apply to some widgets. This requires knowledge of how each widget
1469     * is themed, as extensions will always replace the entire group used by
1470     * the widget, so important signals and parts need to be there for the
1471     * object to behave properly (see documentation of Edje for details).
1472     * Once the theme for the extension is done, the application needs to add
1473     * it to the list of themes Elementary will look into, using
1474     * elm_theme_extension_add(), and set the style of the desired widgets as
1475     * he would normally with elm_object_style_set().
1476     *
1477     * Overlays, on the other hand, can replace the look of all widgets by
1478     * overriding the default style. Like extensions, it's up to the application
1479     * developer to write the theme for the widgets it wants, the difference
1480     * being that when looking for the theme, Elementary will check first the
1481     * list of overlays, then the set theme and lastly the list of extensions,
1482     * so with overlays it's possible to replace the default view and every
1483     * widget will be affected. This is very much alike to setting the whole
1484     * theme for the application and will probably clash with the end user
1485     * options, not to mention the risk of ending up with not matching styles
1486     * across the program. Unless there's a very special reason to use them,
1487     * overlays should be avoided for the resons exposed before.
1488     *
1489     * All these theme lists are handled by ::Elm_Theme instances. Elementary
1490     * keeps one default internally and every function that receives one of
1491     * these can be called with NULL to refer to this default (except for
1492     * elm_theme_free()). It's possible to create a new instance of a
1493     * ::Elm_Theme to set other theme for a specific widget (and all of its
1494     * children), but this is as discouraged, if not even more so, than using
1495     * overlays. Don't use this unless you really know what you are doing.
1496     *
1497     * But to be less negative about things, you can look at the following
1498     * examples:
1499     * @li @ref theme_example_01 "Using extensions"
1500     * @li @ref theme_example_02 "Using overlays"
1501     *
1502     * @{
1503     */
1504    /**
1505     * @typedef Elm_Theme
1506     *
1507     * Opaque handler for the list of themes Elementary looks for when
1508     * rendering widgets.
1509     *
1510     * Stay out of this unless you really know what you are doing. For most
1511     * cases, sticking to the default is all a developer needs.
1512     */
1513    typedef struct _Elm_Theme Elm_Theme;
1514
1515    /**
1516     * Create a new specific theme
1517     *
1518     * This creates an empty specific theme that only uses the default theme. A
1519     * specific theme has its own private set of extensions and overlays too
1520     * (which are empty by default). Specific themes do not fall back to themes
1521     * of parent objects. They are not intended for this use. Use styles, overlays
1522     * and extensions when needed, but avoid specific themes unless there is no
1523     * other way (example: you want to have a preview of a new theme you are
1524     * selecting in a "theme selector" window. The preview is inside a scroller
1525     * and should display what the theme you selected will look like, but not
1526     * actually apply it yet. The child of the scroller will have a specific
1527     * theme set to show this preview before the user decides to apply it to all
1528     * applications).
1529     */
1530    EAPI Elm_Theme       *elm_theme_new(void);
1531    /**
1532     * Free a specific theme
1533     *
1534     * @param th The theme to free
1535     *
1536     * This frees a theme created with elm_theme_new().
1537     */
1538    EAPI void             elm_theme_free(Elm_Theme *th);
1539    /**
1540     * Copy the theme fom the source to the destination theme
1541     *
1542     * @param th The source theme to copy from
1543     * @param thdst The destination theme to copy data to
1544     *
1545     * This makes a one-time static copy of all the theme config, extensions
1546     * and overlays from @p th to @p thdst. If @p th references a theme, then
1547     * @p thdst is also set to reference it, with all the theme settings,
1548     * overlays and extensions that @p th had.
1549     */
1550    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1551    /**
1552     * Tell the source theme to reference the ref theme
1553     *
1554     * @param th The theme that will do the referencing
1555     * @param thref The theme that is the reference source
1556     *
1557     * This clears @p th to be empty and then sets it to refer to @p thref
1558     * so @p th acts as an override to @p thref, but where its overrides
1559     * don't apply, it will fall through to @pthref for configuration.
1560     */
1561    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1562    /**
1563     * Return the theme referred to
1564     *
1565     * @param th The theme to get the reference from
1566     * @return The referenced theme handle
1567     *
1568     * This gets the theme set as the reference theme by elm_theme_ref_set().
1569     * If no theme is set as a reference, NULL is returned.
1570     */
1571    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
1572    /**
1573     * Return the default theme
1574     *
1575     * @return The default theme handle
1576     *
1577     * This returns the internal default theme setup handle that all widgets
1578     * use implicitly unless a specific theme is set. This is also often use
1579     * as a shorthand of NULL.
1580     */
1581    EAPI Elm_Theme       *elm_theme_default_get(void);
1582    /**
1583     * Prepends a theme overlay to the list of overlays
1584     *
1585     * @param th The theme to add to, or if NULL, the default theme
1586     * @param item The Edje file path to be used
1587     *
1588     * Use this if your application needs to provide some custom overlay theme
1589     * (An Edje file that replaces some default styles of widgets) where adding
1590     * new styles, or changing system theme configuration is not possible. Do
1591     * NOT use this instead of a proper system theme configuration. Use proper
1592     * configuration files, profiles, environment variables etc. to set a theme
1593     * so that the theme can be altered by simple confiugration by a user. Using
1594     * this call to achieve that effect is abusing the API and will create lots
1595     * of trouble.
1596     *
1597     * @see elm_theme_extension_add()
1598     */
1599    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
1600    /**
1601     * Delete a theme overlay from the list of overlays
1602     *
1603     * @param th The theme to delete from, or if NULL, the default theme
1604     * @param item The name of the theme overlay
1605     *
1606     * @see elm_theme_overlay_add()
1607     */
1608    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
1609    /**
1610     * Appends a theme extension to the list of extensions.
1611     *
1612     * @param th The theme to add to, or if NULL, the default theme
1613     * @param item The Edje file path to be used
1614     *
1615     * This is intended when an application needs more styles of widgets or new
1616     * widget themes that the default does not provide (or may not provide). The
1617     * application has "extended" usage by coming up with new custom style names
1618     * for widgets for specific uses, but as these are not "standard", they are
1619     * not guaranteed to be provided by a default theme. This means the
1620     * application is required to provide these extra elements itself in specific
1621     * Edje files. This call adds one of those Edje files to the theme search
1622     * path to be search after the default theme. The use of this call is
1623     * encouraged when default styles do not meet the needs of the application.
1624     * Use this call instead of elm_theme_overlay_add() for almost all cases.
1625     *
1626     * @see elm_object_style_set()
1627     */
1628    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
1629    /**
1630     * Deletes a theme extension from the list of extensions.
1631     *
1632     * @param th The theme to delete from, or if NULL, the default theme
1633     * @param item The name of the theme extension
1634     *
1635     * @see elm_theme_extension_add()
1636     */
1637    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
1638    /**
1639     * Set the theme search order for the given theme
1640     *
1641     * @param th The theme to set the search order, or if NULL, the default theme
1642     * @param theme Theme search string
1643     *
1644     * This sets the search string for the theme in path-notation from first
1645     * theme to search, to last, delimited by the : character. Example:
1646     *
1647     * "shiny:/path/to/file.edj:default"
1648     *
1649     * See the ELM_THEME environment variable for more information.
1650     *
1651     * @see elm_theme_get()
1652     * @see elm_theme_list_get()
1653     */
1654    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
1655    /**
1656     * Return the theme search order
1657     *
1658     * @param th The theme to get the search order, or if NULL, the default theme
1659     * @return The internal search order path
1660     *
1661     * This function returns a colon separated string of theme elements as
1662     * returned by elm_theme_list_get().
1663     *
1664     * @see elm_theme_set()
1665     * @see elm_theme_list_get()
1666     */
1667    EAPI const char      *elm_theme_get(Elm_Theme *th);
1668    /**
1669     * Return a list of theme elements to be used in a theme.
1670     *
1671     * @param th Theme to get the list of theme elements from.
1672     * @return The internal list of theme elements
1673     *
1674     * This returns the internal list of theme elements (will only be valid as
1675     * long as the theme is not modified by elm_theme_set() or theme is not
1676     * freed by elm_theme_free(). This is a list of strings which must not be
1677     * altered as they are also internal. If @p th is NULL, then the default
1678     * theme element list is returned.
1679     *
1680     * A theme element can consist of a full or relative path to a .edj file,
1681     * or a name, without extension, for a theme to be searched in the known
1682     * theme paths for Elemementary.
1683     *
1684     * @see elm_theme_set()
1685     * @see elm_theme_get()
1686     */
1687    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1688    /**
1689     * Return the full patrh for a theme element
1690     *
1691     * @param f The theme element name
1692     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1693     * @return The full path to the file found.
1694     *
1695     * This returns a string you should free with free() on success, NULL on
1696     * failure. This will search for the given theme element, and if it is a
1697     * full or relative path element or a simple searchable name. The returned
1698     * path is the full path to the file, if searched, and the file exists, or it
1699     * is simply the full path given in the element or a resolved path if
1700     * relative to home. The @p in_search_path boolean pointed to is set to
1701     * EINA_TRUE if the file was a searchable file andis in the search path,
1702     * and EINA_FALSE otherwise.
1703     */
1704    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1705    /**
1706     * Flush the current theme.
1707     *
1708     * @param th Theme to flush
1709     *
1710     * This flushes caches that let elementary know where to find theme elements
1711     * in the given theme. If @p th is NULL, then the default theme is flushed.
1712     * Call this function if source theme data has changed in such a way as to
1713     * make any caches Elementary kept invalid.
1714     */
1715    EAPI void             elm_theme_flush(Elm_Theme *th);
1716    /**
1717     * This flushes all themes (default and specific ones).
1718     *
1719     * This will flush all themes in the current application context, by calling
1720     * elm_theme_flush() on each of them.
1721     */
1722    EAPI void             elm_theme_full_flush(void);
1723    /**
1724     * Set the theme for all elementary using applications on the current display
1725     *
1726     * @param theme The name of the theme to use. Format same as the ELM_THEME
1727     * environment variable.
1728     */
1729    EAPI void             elm_theme_all_set(const char *theme);
1730    /**
1731     * Return a list of theme elements in the theme search path
1732     *
1733     * @return A list of strings that are the theme element names.
1734     *
1735     * This lists all available theme files in the standard Elementary search path
1736     * for theme elements, and returns them in alphabetical order as theme
1737     * element names in a list of strings. Free this with
1738     * elm_theme_name_available_list_free() when you are done with the list.
1739     */
1740    EAPI Eina_List       *elm_theme_name_available_list_new(void);
1741    /**
1742     * Free the list returned by elm_theme_name_available_list_new()
1743     *
1744     * This frees the list of themes returned by
1745     * elm_theme_name_available_list_new(). Once freed the list should no longer
1746     * be used. a new list mys be created.
1747     */
1748    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
1749    /**
1750     * Set a specific theme to be used for this object and its children
1751     *
1752     * @param obj The object to set the theme on
1753     * @param th The theme to set
1754     *
1755     * This sets a specific theme that will be used for the given object and any
1756     * child objects it has. If @p th is NULL then the theme to be used is
1757     * cleared and the object will inherit its theme from its parent (which
1758     * ultimately will use the default theme if no specific themes are set).
1759     *
1760     * Use special themes with great care as this will annoy users and make
1761     * configuration difficult. Avoid any custom themes at all if it can be
1762     * helped.
1763     */
1764    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1765    /**
1766     * Get the specific theme to be used
1767     *
1768     * @param obj The object to get the specific theme from
1769     * @return The specifc theme set.
1770     *
1771     * This will return a specific theme set, or NULL if no specific theme is
1772     * set on that object. It will not return inherited themes from parents, only
1773     * the specific theme set for that specific object. See elm_object_theme_set()
1774     * for more information.
1775     */
1776    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1777    /**
1778     * @}
1779     */
1780
1781    /* win */
1782    typedef enum _Elm_Win_Type
1783      {
1784         ELM_WIN_BASIC,
1785         ELM_WIN_DIALOG_BASIC,
1786         ELM_WIN_DESKTOP,
1787         ELM_WIN_DOCK,
1788         ELM_WIN_TOOLBAR,
1789         ELM_WIN_MENU,
1790         ELM_WIN_UTILITY,
1791         ELM_WIN_SPLASH,
1792         ELM_WIN_DROPDOWN_MENU,
1793         ELM_WIN_POPUP_MENU,
1794         ELM_WIN_TOOLTIP,
1795         ELM_WIN_NOTIFICATION,
1796         ELM_WIN_COMBO,
1797         ELM_WIN_DND,
1798         ELM_WIN_INLINED_IMAGE,
1799      } Elm_Win_Type;
1800
1801    typedef enum _Elm_Win_Keyboard_Mode
1802      {
1803         ELM_WIN_KEYBOARD_UNKNOWN,
1804         ELM_WIN_KEYBOARD_OFF,
1805         ELM_WIN_KEYBOARD_ON,
1806         ELM_WIN_KEYBOARD_ALPHA,
1807         ELM_WIN_KEYBOARD_NUMERIC,
1808         ELM_WIN_KEYBOARD_PIN,
1809         ELM_WIN_KEYBOARD_PHONE_NUMBER,
1810         ELM_WIN_KEYBOARD_HEX,
1811         ELM_WIN_KEYBOARD_TERMINAL,
1812         ELM_WIN_KEYBOARD_PASSWORD,
1813         ELM_WIN_KEYBOARD_IP,
1814         ELM_WIN_KEYBOARD_HOST,
1815         ELM_WIN_KEYBOARD_FILE,
1816         ELM_WIN_KEYBOARD_URL,
1817         ELM_WIN_KEYBOARD_KEYPAD,
1818         ELM_WIN_KEYBOARD_J2ME
1819      } Elm_Win_Keyboard_Mode;
1820
1821    typedef enum _Elm_Illume_Command
1822      {
1823         ELM_ILLUME_COMMAND_FOCUS_BACK,
1824         ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1825         ELM_ILLUME_COMMAND_FOCUS_HOME,
1826         ELM_ILLUME_COMMAND_CLOSE
1827      } Elm_Illume_Command;
1828
1829    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1830    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1831    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1832    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1833    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1834    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1835    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1836    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1837    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1838    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1839    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1840    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1841    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1842    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1843    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1844    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1845    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1846    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1847    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1848    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1849    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1850    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1851    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1852    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1853    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1854    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1855    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1856    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1857    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1858    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1859    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1860    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1861    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1862    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1863    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1864    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1865    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1866    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1867    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1868    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1869    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1870    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1871    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1872    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
1873    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
1874    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1875    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1876    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1877    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1878    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1879    EAPI void         elm_win_indicator_state_set(Evas_Object *obj, int show_state);
1880    EAPI int          elm_win_indicator_state_get(Evas_Object *obj);
1881    /*...
1882     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1883     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1884     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1885     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1886     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1887     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1888     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1889     *
1890     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1891     * (blank mouse, private mouse obj, defaultmouse)
1892     *
1893     */
1894    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1895    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1896    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1897    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1898
1899    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1900
1901    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1902    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1903    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1904    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1905    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1906    /* available styles:
1907     * default
1908     * minimal
1909     * minimal_vertical
1910     */
1911    /* X specific calls - won't work on non-x engines (return 0) */
1912    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1913    /* smart callbacks called:
1914     * "delete,request" - the user requested to delete the window
1915     * "focus,in" - window got focus
1916     * "focus,out" - window lost focus
1917     * "moved" - window that holds the canvas was moved
1918     */
1919
1920    /**
1921     * @defgroup Bg Bg
1922     *
1923     * @brief Background object, used for setting a solid color, image or Edje
1924     * group as background to a window or any container object.
1925     *
1926     * The bg object is used for setting a solid background to a window or
1927     * packing into any container object. It works just like an image, but has
1928     * some properties useful to a background, like setting it to tiled,
1929     * centered, scaled or stretched.
1930     *
1931     * Here is some sample code using it:
1932     * @li @ref bg_01_example_page
1933     * @li @ref bg_02_example_page
1934     * @li @ref bg_03_example_page
1935     */
1936
1937    /* bg */
1938    typedef enum _Elm_Bg_Option
1939      {
1940         ELM_BG_OPTION_CENTER,  /**< center the background */
1941         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
1942         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1943         ELM_BG_OPTION_TILE     /**< tile background at its original size */
1944      } Elm_Bg_Option;
1945
1946    /**
1947     * Add a new background to the parent
1948     *
1949     * @param parent The parent object
1950     * @return The new object or NULL if it cannot be created
1951     *
1952     * @ingroup Bg
1953     */
1954    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1955
1956    /**
1957     * Set the file (image or edje) used for the background
1958     *
1959     * @param obj The bg object
1960     * @param file The file path
1961     * @param group Optional key (group in Edje) within the file
1962     *
1963     * This sets the image file used in the background object. The image (or edje)
1964     * will be stretched (retaining aspect if its an image file) to completely fill
1965     * the bg object. This may mean some parts are not visible.
1966     *
1967     * @note  Once the image of @p obj is set, a previously set one will be deleted,
1968     * even if @p file is NULL.
1969     *
1970     * @ingroup Bg
1971     */
1972    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1973
1974    /**
1975     * Get the file (image or edje) used for the background
1976     *
1977     * @param obj The bg object
1978     * @param file The file path
1979     * @param group Optional key (group in Edje) within the file
1980     *
1981     * @ingroup Bg
1982     */
1983    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1984
1985    /**
1986     * Set the option used for the background image
1987     *
1988     * @param obj The bg object
1989     * @param option The desired background option (TILE, SCALE)
1990     *
1991     * This sets the option used for manipulating the display of the background
1992     * image. The image can be tiled or scaled.
1993     *
1994     * @ingroup Bg
1995     */
1996    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1997
1998    /**
1999     * Get the option used for the background image
2000     *
2001     * @param obj The bg object
2002     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2003     *
2004     * @ingroup Bg
2005     */
2006    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2007    /**
2008     * Set the option used for the background color
2009     *
2010     * @param obj The bg object
2011     * @param r
2012     * @param g
2013     * @param b
2014     *
2015     * This sets the color used for the background rectangle. Its range goes
2016     * from 0 to 255.
2017     *
2018     * @ingroup Bg
2019     */
2020    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2021    /**
2022     * Get the option used for the background color
2023     *
2024     * @param obj The bg object
2025     * @param r
2026     * @param g
2027     * @param b
2028     *
2029     * @ingroup Bg
2030     */
2031    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2032
2033    /**
2034     * Set the overlay object used for the background object.
2035     *
2036     * @param obj The bg object
2037     * @param overlay The overlay object
2038     *
2039     * This provides a way for elm_bg to have an 'overlay' that will be on top
2040     * of the bg. Once the over object is set, a previously set one will be
2041     * deleted, even if you set the new one to NULL. If you want to keep that
2042     * old content object, use the elm_bg_overlay_unset() function.
2043     *
2044     * @ingroup Bg
2045     */
2046
2047    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2048
2049    /**
2050     * Get the overlay object used for the background object.
2051     *
2052     * @param obj The bg object
2053     * @return The content that is being used
2054     *
2055     * Return the content object which is set for this widget
2056     *
2057     * @ingroup Bg
2058     */
2059    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2060
2061    /**
2062     * Get the overlay object used for the background object.
2063     *
2064     * @param obj The bg object
2065     * @return The content that was being used
2066     *
2067     * Unparent and return the overlay object which was set for this widget
2068     *
2069     * @ingroup Bg
2070     */
2071    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2072
2073    /**
2074     * Set the size of the pixmap representation of the image.
2075     *
2076     * This option just makes sense if an image is going to be set in the bg.
2077     *
2078     * @param obj The bg object
2079     * @param w The new width of the image pixmap representation.
2080     * @param h The new height of the image pixmap representation.
2081     *
2082     * This function sets a new size for pixmap representation of the given bg
2083     * image. It allows the image to be loaded already in the specified size,
2084     * reducing the memory usage and load time when loading a big image with load
2085     * size set to a smaller size.
2086     *
2087     * NOTE: this is just a hint, the real size of the pixmap may differ
2088     * depending on the type of image being loaded, being bigger than requested.
2089     *
2090     * @ingroup Bg
2091     */
2092    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2093    /* smart callbacks called:
2094     */
2095
2096    /* icon */
2097    typedef enum _Elm_Icon_Lookup_Order
2098      {
2099         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2100         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2101         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
2102         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
2103      } Elm_Icon_Lookup_Order;
2104
2105    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2106    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2107    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2108    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2109    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2110    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2111    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2112    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2113    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2114    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2115    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2116    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2117    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2118    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2119    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2120    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2121    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2122    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2123    EAPI Eina_Bool             elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2124    EAPI void                  elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
2125    EAPI Eina_Bool             elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2126    EAPI void                  elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
2127    EAPI Eina_Bool             elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2128
2129    /* smart callbacks called:
2130     * "clicked" - the user clicked the icon
2131     */
2132
2133    /* image */
2134    typedef enum _Elm_Image_Orient
2135      {
2136         ELM_IMAGE_ORIENT_NONE,
2137         ELM_IMAGE_ROTATE_90_CW,
2138         ELM_IMAGE_ROTATE_180_CW,
2139         ELM_IMAGE_ROTATE_90_CCW,
2140         ELM_IMAGE_FLIP_HORIZONTAL,
2141         ELM_IMAGE_FLIP_VERTICAL,
2142         ELM_IMAGE_FLIP_TRANSPOSE,
2143         ELM_IMAGE_FLIP_TRANSVERSE
2144      } Elm_Image_Orient;
2145    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2146    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2147    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2148    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2149    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2150    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2151    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2152    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2153    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2154    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2155    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2156    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2157    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2158    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2159    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2160    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2161    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2162    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2163    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2164    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2165    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2166
2167    /* smart callbacks called:
2168     * "clicked" - the user clicked the image
2169     */
2170
2171    /* glview */
2172    typedef void (*Elm_GLView_Func)(Evas_Object *obj);
2173
2174    typedef enum _Elm_GLView_Mode
2175      {
2176         ELM_GLVIEW_ALPHA   = 1,
2177         ELM_GLVIEW_DEPTH   = 2,
2178         ELM_GLVIEW_STENCIL = 4
2179      } Elm_GLView_Mode;
2180
2181    /**
2182     * Defines a policy for the glview resizing.
2183     *
2184     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2185     */
2186    typedef enum _Elm_GLView_Resize_Policy
2187      {
2188         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
2189         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
2190      } Elm_GLView_Resize_Policy;
2191
2192    typedef enum _Elm_GLView_Render_Policy
2193      {
2194         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
2195         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
2196      } Elm_GLView_Render_Policy;
2197
2198
2199    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2200    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2201    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2202    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2203    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2204    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2205    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2206    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2207    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2208    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2209    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2210    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2211
2212    /* box */
2213    /**
2214     * @defgroup Box Box
2215     *
2216     * A box arranges objects in a linear fashion, governed by a layout function
2217     * that defines the details of this arrangement.
2218     *
2219     * By default, the box will use an internal function to set the layout to
2220     * a single row, either vertical or horizontal. This layout is affected
2221     * by a number of parameters, such as the homogeneous flag set by
2222     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2223     * elm_box_align_set() and the hints set to each object in the box.
2224     *
2225     * For this default layout, it's possible to change the orientation with
2226     * elm_box_horizontal_set(). The box will start in the vertical orientation,
2227     * placing its elements ordered from top to bottom. When horizontal is set,
2228     * the order will go from left to right. If the box is set to be
2229     * homogeneous, every object in it will be assigned the same space, that
2230     * of the largest object. Padding can be used to set some spacing between
2231     * the cell given to each object. The alignment of the box, set with
2232     * elm_box_align_set(), determines how the bounding box of all the elements
2233     * will be placed within the space given to the box widget itself.
2234     *
2235     * The size hints of each object also affect how they are placed and sized
2236     * within the box. evas_object_size_hint_min_set() will give the minimum
2237     * size the object can have, and the box will use it as the basis for all
2238     * latter calculations. Elementary widgets set their own minimum size as
2239     * needed, so there's rarely any need to use it manually.
2240     *
2241     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2242     * used to tell whether the object will be allocated the minimum size it
2243     * needs or if the space given to it should be expanded. It's important
2244     * to realize that expanding the size given to the object is not the same
2245     * thing as resizing the object. It could very well end being a small
2246     * widget floating in a much larger empty space. If not set, the weight
2247     * for objects will normally be 0.0 for both axis, meaning the widget will
2248     * not be expanded. To take as much space possible, set the weight to
2249     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2250     *
2251     * Besides how much space each object is allocated, it's possible to control
2252     * how the widget will be placed within that space using
2253     * evas_object_size_hint_align_set(). By default, this value will be 0.5
2254     * for both axis, meaning the object will be centered, but any value from
2255     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2256     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2257     * is -1.0, means the object will be resized to fill the entire space it
2258     * was allocated.
2259     *
2260     * In addition, customized functions to define the layout can be set, which
2261     * allow the application developer to organize the objects within the box
2262     * in any number of ways.
2263     *
2264     * The special elm_box_layout_transition() function can be used
2265     * to switch from one layout to another, animating the motion of the
2266     * children of the box.
2267     *
2268     * @note Objects should not be added to box objects using _add() calls.
2269     *
2270     * Some examples on how to use boxes follow:
2271     * @li @ref box_example_01
2272     * @li @ref box_example_02
2273     *
2274     * @{
2275     */
2276    /**
2277     * @typedef Elm_Box_Transition
2278     *
2279     * Opaque handler containing the parameters to perform an animated
2280     * transition of the layout the box uses.
2281     *
2282     * @see elm_box_transition_new()
2283     * @see elm_box_layout_set()
2284     * @see elm_box_layout_transition()
2285     */
2286    typedef struct _Elm_Box_Transition Elm_Box_Transition;
2287
2288    /**
2289     * Add a new box to the parent
2290     *
2291     * By default, the box will be in vertical mode and non-homogeneous.
2292     *
2293     * @param parent The parent object
2294     * @return The new object or NULL if it cannot be created
2295     */
2296    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2297    /**
2298     * Set the horizontal orientation
2299     *
2300     * By default, box object arranges their contents vertically from top to
2301     * bottom.
2302     * By calling this function with @p horizontal as EINA_TRUE, the box will
2303     * become horizontal, arranging contents from left to right.
2304     *
2305     * @note This flag is ignored if a custom layout function is set.
2306     *
2307     * @param obj The box object
2308     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2309     * EINA_FALSE = vertical)
2310     */
2311    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2312    /**
2313     * Get the horizontal orientation
2314     *
2315     * @param obj The box object
2316     * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2317     */
2318    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2319    /**
2320     * Set the box to arrange its children homogeneously
2321     *
2322     * If enabled, homogeneous layout makes all items the same size, according
2323     * to the size of the largest of its children.
2324     *
2325     * @note This flag is ignored if a custom layout function is set.
2326     *
2327     * @param obj The box object
2328     * @param homogeneous The homogeneous flag
2329     */
2330    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2331    /**
2332     * Get whether the box is using homogeneous mode or not
2333     *
2334     * @param obj The box object
2335     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2336     */
2337    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2338    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2339    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2340    /**
2341     * Add an object to the beginning of the pack list
2342     *
2343     * Pack @p subobj into the box @p obj, placing it first in the list of
2344     * children objects. The actual position the object will get on screen
2345     * depends on the layout used. If no custom layout is set, it will be at
2346     * the top or left, depending if the box is vertical or horizontal,
2347     * respectively.
2348     *
2349     * @param obj The box object
2350     * @param subobj The object to add to the box
2351     *
2352     * @see elm_box_pack_end()
2353     * @see elm_box_pack_before()
2354     * @see elm_box_pack_after()
2355     * @see elm_box_unpack()
2356     * @see elm_box_unpack_all()
2357     * @see elm_box_clear()
2358     */
2359    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2360    /**
2361     * Add an object at the end of the pack list
2362     *
2363     * Pack @p subobj into the box @p obj, placing it last in the list of
2364     * children objects. The actual position the object will get on screen
2365     * depends on the layout used. If no custom layout is set, it will be at
2366     * the bottom or right, depending if the box is vertical or horizontal,
2367     * respectively.
2368     *
2369     * @param obj The box object
2370     * @param subobj The object to add to the box
2371     *
2372     * @see elm_box_pack_start()
2373     * @see elm_box_pack_before()
2374     * @see elm_box_pack_after()
2375     * @see elm_box_unpack()
2376     * @see elm_box_unpack_all()
2377     * @see elm_box_clear()
2378     */
2379    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2380    /**
2381     * Adds an object to the box before the indicated object
2382     *
2383     * This will add the @p subobj to the box indicated before the object
2384     * indicated with @p before. If @p before is not already in the box, results
2385     * are undefined. Before means either to the left of the indicated object or
2386     * above it depending on orientation.
2387     *
2388     * @param obj The box object
2389     * @param subobj The object to add to the box
2390     * @param before The object before which to add it
2391     *
2392     * @see elm_box_pack_start()
2393     * @see elm_box_pack_end()
2394     * @see elm_box_pack_after()
2395     * @see elm_box_unpack()
2396     * @see elm_box_unpack_all()
2397     * @see elm_box_clear()
2398     */
2399    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2400    /**
2401     * Adds an object to the box after the indicated object
2402     *
2403     * This will add the @p subobj to the box indicated after the object
2404     * indicated with @p after. If @p after is not already in the box, results
2405     * are undefined. After means either to the right of the indicated object or
2406     * below it depending on orientation.
2407     *
2408     * @param obj The box object
2409     * @param subobj The object to add to the box
2410     * @param after The object after which to add it
2411     *
2412     * @see elm_box_pack_start()
2413     * @see elm_box_pack_end()
2414     * @see elm_box_pack_before()
2415     * @see elm_box_unpack()
2416     * @see elm_box_unpack_all()
2417     * @see elm_box_clear()
2418     */
2419    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2420    /**
2421     * Clear the box of all children
2422     *
2423     * Remove all the elements contained by the box, deleting the respective
2424     * objects.
2425     *
2426     * @param obj The box object
2427     *
2428     * @see elm_box_unpack()
2429     * @see elm_box_unpack_all()
2430     */
2431    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2432    /**
2433     * Unpack a box item
2434     *
2435     * Remove the object given by @p subobj from the box @p obj without
2436     * deleting it.
2437     *
2438     * @param obj The box object
2439     *
2440     * @see elm_box_unpack_all()
2441     * @see elm_box_clear()
2442     */
2443    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2444    /**
2445     * Remove all items from the box, without deleting them
2446     *
2447     * Clear the box from all children, but don't delete the respective objects.
2448     * If no other references of the box children exist, the objects will never
2449     * be deleted, and thus the application will leak the memory. Make sure
2450     * when using this function that you hold a reference to all the objects
2451     * in the box @p obj.
2452     *
2453     * @param obj The box object
2454     *
2455     * @see elm_box_clear()
2456     * @see elm_box_unpack()
2457     */
2458    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2459    /**
2460     * Retrieve a list of the objects packed into the box
2461     *
2462     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2463     * The order of the list corresponds to the packing order the box uses.
2464     *
2465     * You must free this list with eina_list_free() once you are done with it.
2466     *
2467     * @param obj The box object
2468     */
2469    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2470    /**
2471     * Set the space (padding) between the box's elements.
2472     *
2473     * Extra space in pixels that will be added between a box child and its
2474     * neighbors after its containing cell has been calculated. This padding
2475     * is set for all elements in the box, besides any possible padding that
2476     * individual elements may have through their size hints.
2477     *
2478     * @param obj The box object
2479     * @param horizontal The horizontal space between elements
2480     * @param vertical The vertical space between elements
2481     */
2482    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2483    /**
2484     * Get the space (padding) between the box's elements.
2485     *
2486     * @param obj The box object
2487     * @param horizontal The horizontal space between elements
2488     * @param vertical The vertical space between elements
2489     *
2490     * @see elm_box_padding_set()
2491     */
2492    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2493    /**
2494     * Set the alignment of the whole bouding box of contents.
2495     *
2496     * Sets how the bounding box containing all the elements of the box, after
2497     * their sizes and position has been calculated, will be aligned within
2498     * the space given for the whole box widget.
2499     *
2500     * @param obj The box object
2501     * @param horizontal The horizontal alignment of elements
2502     * @param vertical The vertical alignment of elements
2503     */
2504    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2505    /**
2506     * Get the alignment of the whole bouding box of contents.
2507     *
2508     * @param obj The box object
2509     * @param horizontal The horizontal alignment of elements
2510     * @param vertical The vertical alignment of elements
2511     *
2512     * @see elm_box_align_set()
2513     */
2514    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2515
2516    /**
2517     * Set the layout defining function to be used by the box
2518     *
2519     * Whenever anything changes that requires the box in @p obj to recalculate
2520     * the size and position of its elements, the function @p cb will be called
2521     * to determine what the layout of the children will be.
2522     *
2523     * Once a custom function is set, everything about the children layout
2524     * is defined by it. The flags set by elm_box_horizontal_set() and
2525     * elm_box_homogeneous_set() no longer have any meaning, and the values
2526     * given by elm_box_padding_set() and elm_box_align_set() are up to this
2527     * layout function to decide if they are used and how. These last two
2528     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2529     * passed to @p cb. The @c Evas_Object the function receives is not the
2530     * Elementary widget, but the internal Evas Box it uses, so none of the
2531     * functions described here can be used on it.
2532     *
2533     * Any of the layout functions in @c Evas can be used here, as well as the
2534     * special elm_box_layout_transition().
2535     *
2536     * The final @p data argument received by @p cb is the same @p data passed
2537     * here, and the @p free_data function will be called to free it
2538     * whenever the box is destroyed or another layout function is set.
2539     *
2540     * Setting @p cb to NULL will revert back to the default layout function.
2541     *
2542     * @param obj The box object
2543     * @param cb The callback function used for layout
2544     * @param data Data that will be passed to layout function
2545     * @param free_data Function called to free @p data
2546     *
2547     * @see elm_box_layout_transition()
2548     */
2549    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);
2550    /**
2551     * Special layout function that animates the transition from one layout to another
2552     *
2553     * Normally, when switching the layout function for a box, this will be
2554     * reflected immediately on screen on the next render, but it's also
2555     * possible to do this through an animated transition.
2556     *
2557     * This is done by creating an ::Elm_Box_Transition and setting the box
2558     * layout to this function.
2559     *
2560     * For example:
2561     * @code
2562     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2563     *                            evas_object_box_layout_vertical, // start
2564     *                            NULL, // data for initial layout
2565     *                            NULL, // free function for initial data
2566     *                            evas_object_box_layout_horizontal, // end
2567     *                            NULL, // data for final layout
2568     *                            NULL, // free function for final data
2569     *                            anim_end, // will be called when animation ends
2570     *                            NULL); // data for anim_end function\
2571     * elm_box_layout_set(box, elm_box_layout_transition, t,
2572     *                    elm_box_transition_free);
2573     * @endcode
2574     *
2575     * @note This function can only be used with elm_box_layout_set(). Calling
2576     * it directly will not have the expected results.
2577     *
2578     * @see elm_box_transition_new
2579     * @see elm_box_transition_free
2580     * @see elm_box_layout_set
2581     */
2582    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2583    /**
2584     * Create a new ::Elm_Box_Transition to animate the switch of layouts
2585     *
2586     * If you want to animate the change from one layout to another, you need
2587     * to set the layout function of the box to elm_box_layout_transition(),
2588     * passing as user data to it an instance of ::Elm_Box_Transition with the
2589     * necessary information to perform this animation. The free function to
2590     * set for the layout is elm_box_transition_free().
2591     *
2592     * The parameters to create an ::Elm_Box_Transition sum up to how long
2593     * will it be, in seconds, a layout function to describe the initial point,
2594     * another for the final position of the children and one function to be
2595     * called when the whole animation ends. This last function is useful to
2596     * set the definitive layout for the box, usually the same as the end
2597     * layout for the animation, but could be used to start another transition.
2598     *
2599     * @param start_layout The layout function that will be used to start the animation
2600     * @param start_layout_data The data to be passed the @p start_layout function
2601     * @param start_layout_free_data Function to free @p start_layout_data
2602     * @param end_layout The layout function that will be used to end the animation
2603     * @param end_layout_free_data The data to be passed the @p end_layout function
2604     * @param end_layout_free_data Function to free @p end_layout_data
2605     * @param transition_end_cb Callback function called when animation ends
2606     * @param transition_end_data Data to be passed to @p transition_end_cb
2607     * @return An instance of ::Elm_Box_Transition
2608     *
2609     * @see elm_box_transition_new
2610     * @see elm_box_layout_transition
2611     */
2612    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);
2613    /**
2614     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2615     *
2616     * This function is mostly useful as the @c free_data parameter in
2617     * elm_box_layout_set() when elm_box_layout_transition().
2618     *
2619     * @param data The Elm_Box_Transition instance to be freed.
2620     *
2621     * @see elm_box_transition_new
2622     * @see elm_box_layout_transition
2623     */
2624    EAPI void                elm_box_transition_free(void *data);
2625    /**
2626     * @}
2627     */
2628
2629    /* button */
2630    /**
2631     * @defgroup Button Button
2632     *
2633     * @image html  widget/button/preview-00.png
2634     * @image html  widget/button/preview-01.png
2635     * @image html  widget/button/preview-02.png
2636     *
2637     * This is a push-button. Press it and run some function. It can contain
2638     * a simple label and icon object and it also has an autorepeat feature.
2639     *
2640     * This widgets emits the following signals:
2641     * @li "clicked": the user clicked the button (press/release).
2642     * @li "repeated": the user pressed the button without releasing it.
2643     * @li "pressed": button was pressed.
2644     * @li "unpressed": button was released after being pressed.
2645     * In all three cases, the @c event parameter of the callback will be
2646     * @c NULL.
2647     *
2648     * Also, defined in the default theme, the button has the following styles
2649     * available:
2650     * @li default: a normal button.
2651     * @li anchor: Like default, but the button fades away when the mouse is not
2652     * over it, leaving only the text or icon.
2653     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2654     * continuous look across its options.
2655     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2656     *
2657     * Follow through a complete example @ref button_example_01 "here".
2658     * @{
2659     */
2660
2661    typedef enum
2662      {
2663         UIControlStateDefault,
2664         UIControlStateHighlighted,
2665         UIControlStateDisabled,
2666         UIControlStateFocused,
2667         UIControlStateReserved
2668      } UIControlState;
2669
2670    /**
2671     * Add a new button to the parent's canvas
2672     *
2673     * @param parent The parent object
2674     * @return The new object or NULL if it cannot be created
2675     */
2676    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2677    /**
2678     * Set the label used in the button
2679     *
2680     * The passed @p label can be NULL to clean any existing text in it and
2681     * leave the button as an icon only object.
2682     *
2683     * @param obj The button object
2684     * @param label The text will be written on the button
2685     * @deprecated use elm_object_text_set() instead.
2686     */
2687    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2688    /**
2689     * Get the label set for the button
2690     *
2691     * The string returned is an internal pointer and should not be freed or
2692     * altered. It will also become invalid when the button is destroyed.
2693     * The string returned, if not NULL, is a stringshare, so if you need to
2694     * keep it around even after the button is destroyed, you can use
2695     * eina_stringshare_ref().
2696     *
2697     * @param obj The button object
2698     * @return The text set to the label, or NULL if nothing is set
2699     * @deprecated use elm_object_text_set() instead.
2700     */
2701    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2702    /**
2703     * Set the label for each state of button
2704     *
2705     * The passed @p label can be NULL to clean any existing text in it and
2706     * leave the button as an icon only object for the state.
2707     *
2708     * @param obj The button object
2709     * @param label The text will be written on the button
2710     * @param state The state of button
2711     *
2712     * @ingroup Button
2713     */
2714    EINA_DEPRECATED EAPI void         elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
2715    /**
2716     * Get the label of button for each state
2717     *
2718     * The string returned is an internal pointer and should not be freed or
2719     * altered. It will also become invalid when the button is destroyed.
2720     * The string returned, if not NULL, is a stringshare, so if you need to
2721     * keep it around even after the button is destroyed, you can use
2722     * eina_stringshare_ref().
2723     *
2724     * @param obj The button object
2725     * @param state The state of button
2726     * @return The title of button for state
2727     *
2728     * @ingroup Button
2729     */
2730    EINA_DEPRECATED EAPI const char  *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
2731    /**
2732     * Set the icon used for the button
2733     *
2734     * Setting a new icon will delete any other that was previously set, making
2735     * any reference to them invalid. If you need to maintain the previous
2736     * object alive, unset it first with elm_button_icon_unset().
2737     *
2738     * @param obj The button object
2739     * @param icon The icon object for the button
2740     */
2741    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2742    /**
2743     * Get the icon used for the button
2744     *
2745     * Return the icon object which is set for this widget. If the button is
2746     * destroyed or another icon is set, the returned object will be deleted
2747     * and any reference to it will be invalid.
2748     *
2749     * @param obj The button object
2750     * @return The icon object that is being used
2751     *
2752     * @see elm_button_icon_unset()
2753     */
2754    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2755    /**
2756     * Remove the icon set without deleting it and return the object
2757     *
2758     * This function drops the reference the button holds of the icon object
2759     * and returns this last object. It is used in case you want to remove any
2760     * icon, or set another one, without deleting the actual object. The button
2761     * will be left without an icon set.
2762     *
2763     * @param obj The button object
2764     * @return The icon object that was being used
2765     */
2766    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2767    /**
2768     * Turn on/off the autorepeat event generated when the button is kept pressed
2769     *
2770     * When off, no autorepeat is performed and buttons emit a normal @c clicked
2771     * signal when they are clicked.
2772     *
2773     * When on, keeping a button pressed will continuously emit a @c repeated
2774     * signal until the button is released. The time it takes until it starts
2775     * emitting the signal is given by
2776     * elm_button_autorepeat_initial_timeout_set(), and the time between each
2777     * new emission by elm_button_autorepeat_gap_timeout_set().
2778     *
2779     * @param obj The button object
2780     * @param on  A bool to turn on/off the event
2781     */
2782    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
2783    /**
2784     * Get whether the autorepeat feature is enabled
2785     *
2786     * @param obj The button object
2787     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
2788     *
2789     * @see elm_button_autorepeat_set()
2790     */
2791    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2792    /**
2793     * Set the initial timeout before the autorepeat event is generated
2794     *
2795     * Sets the timeout, in seconds, since the button is pressed until the
2796     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
2797     * won't be any delay and the even will be fired the moment the button is
2798     * pressed.
2799     *
2800     * @param obj The button object
2801     * @param t   Timeout in seconds
2802     *
2803     * @see elm_button_autorepeat_set()
2804     * @see elm_button_autorepeat_gap_timeout_set()
2805     */
2806    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2807    /**
2808     * Get the initial timeout before the autorepeat event is generated
2809     *
2810     * @param obj The button object
2811     * @return Timeout in seconds
2812     *
2813     * @see elm_button_autorepeat_initial_timeout_set()
2814     */
2815    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2816    /**
2817     * Set the interval between each generated autorepeat event
2818     *
2819     * After the first @c repeated event is fired, all subsequent ones will
2820     * follow after a delay of @p t seconds for each.
2821     *
2822     * @param obj The button object
2823     * @param t   Interval in seconds
2824     *
2825     * @see elm_button_autorepeat_initial_timeout_set()
2826     */
2827    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2828    /**
2829     * Get the interval between each generated autorepeat event
2830     *
2831     * @param obj The button object
2832     * @return Interval in seconds
2833     */
2834    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2835    /**
2836     * @}
2837     */
2838
2839    /* fileselector */
2840    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2841    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2842    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2843    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2844    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2845    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2846    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2847    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2848    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2849    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2850    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2851    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2852    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2853    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2854    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2855    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2856    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2857    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2858    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2859    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2860    /* available styles:
2861     * default
2862     * anchor
2863     * hoversel_vertical
2864     * hoversel_vertical_entry
2865     */
2866    /* smart callbacks called:
2867     * "file,chosen" - the user has selected a path, whose string pointer comes
2868                       as event info
2869     */
2870
2871    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2872    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2873    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2874    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2875    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2876    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2877    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2878    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2879    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2880    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2881    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2882    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2883    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2884    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2885    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2886    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2887    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2888    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2889    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2890    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2891    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2892    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2893
2894    /* scroller policy */
2895    typedef enum _Elm_Scroller_Policy
2896      {
2897         ELM_SCROLLER_POLICY_AUTO = 0,
2898         ELM_SCROLLER_POLICY_ON,
2899         ELM_SCROLLER_POLICY_OFF,
2900         ELM_SCROLLER_POLICY_LAST
2901      } Elm_Scroller_Policy;
2902
2903    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2904    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2905    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2906    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2907    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2908    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2909    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);
2910    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2911    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2912    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);
2913    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2914    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2915    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2916    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2917    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2918    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);
2919    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2920    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
2921    EINA_DEPRECATED EAPI void         elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
2922    /* smart callbacks called:
2923     * "edge,left" - the left edge of the content has been reached
2924     * "edge,right" - the right edge of the content has been reached
2925     * "edge,top" - the top edge of the content has been reached
2926     * "edge,bottom" - the bottom edge of the content has been reached
2927     * "scroll" - the content has been scrolled (moved)
2928     * "scroll,anim,start" - scrolling animation has started
2929     * "scroll,anim,stop" - scrolling animation has stopped
2930     * "scroll,drag,start" - dragging the contents around has started
2931     * "scroll,drag,stop" - dragging the contents around has stopped
2932     */
2933
2934    /* label */
2935    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2936    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 */
2937    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
2938    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2939    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2940    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
2941    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2942    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
2943    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2944    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
2945    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);
2946    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
2947    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);
2948    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
2949    EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
2950    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
2951    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2952    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
2953    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2954    /* available styles:
2955     * default
2956     * marker
2957     */
2958    /* smart callbacks called:
2959     */
2960
2961    /* toggle */
2962    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2963    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2964    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2965    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2966    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2967    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2968    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
2969    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
2970    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
2971    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2972    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
2973    /* smart callbacks called:
2974     * "changed" - Whenever the toggle value has been changed.  Is not called
2975     *             until the toggle is released by the cursor (assuming it has been triggered
2976     *             by the cursor in the first place).
2977     */
2978
2979    /**
2980     * @page tutorial_frame Frame example
2981     * @dontinclude frame_example_01.c
2982     *
2983     * In this example we are going to create 4 Frames with different styles and
2984     * add a rectangle of different color in each.
2985     *
2986     * We start we the usual setup code:
2987     * @until show(bg)
2988     *
2989     * And then create one rectangle:
2990     * @until show
2991     *
2992     * To add it in our first frame, which since it doesn't have it's style
2993     * specifically set uses the default style:
2994     * @until show
2995     *
2996     * And then create another rectangle:
2997     * @until show
2998     *
2999     * To add it in our second frame, which uses the "pad_small" style, note that
3000     * even tough we are setting a text for this frame it won't be show, only the
3001     * default style shows the Frame's title:
3002     * @until show
3003     * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
3004     * very similar, their only difference is the size of the empty area around
3005     * the content of the frame.
3006     *
3007     * And then create yet another rectangle:
3008     * @until show
3009     *
3010     * To add it in our third frame, which uses the "outdent_top" style, note
3011     * that even tough we are setting a text for this frame it won't be show,
3012     * only the default style shows the Frame's title:
3013     * @until show
3014     *
3015     * And then create one last rectangle:
3016     * @until show
3017     *
3018     * To add it in our fourth and final frame, which uses the "outdent_bottom"
3019     * style, note that even tough we are setting a text for this frame it won't
3020     * be show, only the default style shows the Frame's title:
3021     * @until show
3022     *
3023     * And now we are left with just some more setup code:
3024     * @until ELM_MAIN()
3025     *
3026     * Our example will look like this:
3027     * @image html screenshots/frame_example_01.png
3028     * @image latex screenshots/frame_example_01.eps
3029     *
3030     * @example frame_example_01.c
3031     */
3032    /**
3033     * @defgroup Frame Frame
3034     *
3035     * @brief Frame is a widget that holds some content and has a title.
3036     *
3037     * The default look is a frame with a title, but Frame supports multple
3038     * styles:
3039     * @li default
3040     * @li pad_small
3041     * @li pad_medium
3042     * @li pad_large
3043     * @li pad_huge
3044     * @li outdent_top
3045     * @li outdent_bottom
3046     *
3047     * Of all this styles only default shows the title. Frame emits no signals.
3048     *
3049     * For a detailed example see the @ref tutorial_frame.
3050     *
3051     * @{
3052     */
3053    /**
3054     * @brief Add a new frame to the parent
3055     *
3056     * @param parent The parent object
3057     * @return The new object or NULL if it cannot be created
3058     */
3059    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3060    /**
3061     * @brief Set the frame label
3062     *
3063     * @param obj The frame object
3064     * @param label The label of this frame object
3065     *
3066     * @deprecated use elm_object_text_set() instead.
3067     */
3068    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3069    /**
3070     * @brief Get the frame label
3071     *
3072     * @param obj The frame object
3073     *
3074     * @return The label of this frame objet or NULL if unable to get frame
3075     *
3076     * @deprecated use elm_object_text_get() instead.
3077     */
3078    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3079    /**
3080     * @brief Set the content of the frame widget
3081     *
3082     * Once the content object is set, a previously set one will be deleted.
3083     * If you want to keep that old content object, use the
3084     * elm_frame_content_unset() function.
3085     *
3086     * @param obj The frame object
3087     * @param content The content will be filled in this frame object
3088     */
3089    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3090    /**
3091     * @brief Get the content of the frame widget
3092     *
3093     * Return the content object which is set for this widget
3094     *
3095     * @param obj The frame object
3096     * @return The content that is being used
3097     */
3098    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3099    /**
3100     * @brief Unset the content of the frame widget
3101     *
3102     * Unparent and return the content object which was set for this widget
3103     *
3104     * @param obj The frame object
3105     * @return The content that was being used
3106     */
3107    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3108    /**
3109     * @}
3110     */
3111
3112    /* table */
3113    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3114    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3115    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3116    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3117    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3118    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3119    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3120    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3121    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3122    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
3123    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3124    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
3125
3126    /* gengrid */
3127    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
3128    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
3129    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
3130    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
3131    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
3132    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
3133    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj);
3134
3135    struct _Elm_Gengrid_Item_Class
3136      {
3137         const char             *item_style;
3138         struct _Elm_Gengrid_Item_Class_Func
3139           {
3140              GridItemLabelGetFunc  label_get;
3141              GridItemIconGetFunc   icon_get;
3142              GridItemStateGetFunc  state_get;
3143              GridItemDelFunc       del;
3144           } func;
3145      };
3146
3147    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3148    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
3149    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3150    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
3151    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
3152
3153    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
3154    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3155    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3156    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3157    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3158    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3159    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3160    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3161    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3162    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3163    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3164    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
3165    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3166    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
3167    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3168
3169    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3170    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3171
3172    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3173    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3174    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3175    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3176    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3177    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3178    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
3179    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3180    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
3181    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
3182    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3183    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3184    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3185    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3186    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3187    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3188    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3189
3190    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
3191    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);
3192    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3193    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3194    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3195    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3196    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3197    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3198    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3199    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3200    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3201    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3202
3203    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3204    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3205    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3206
3207    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);
3208    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);
3209    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);
3210    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);
3211    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);
3212    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);
3213    /* smart callbacks called:
3214     *
3215     * selected - User has selected an item.
3216     * unselected - User has unselected an item.
3217     * clicked,double - User has double-clicked or pressed enter on an item.
3218     * realized - An evas object for an item was built.
3219     * unrealized - An evas object for an item was deleted.
3220     * changed - An item has been added, removed, resized or moved,
3221     * or gengrid has been resized or horizontal property has been changed.
3222     * scroll - the content has been scrolled (moved).
3223     * "scroll,drag,start" - dragging the contents around has started.
3224     * "scroll,drag,stop" - dragging the contents around has stopped.
3225     * drag - Gengrid is being dragged.
3226     * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
3227     * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
3228     * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
3229     * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
3230     * "drag,stop" - Gengrid is not being dragged.
3231     */
3232
3233    /**
3234     * @defgroup Clock Clock
3235     *
3236     * This is a @b digital clock widget. In its default theme, it has a
3237     * vintage "flipping numbers clock" appearance, which will animate
3238     * sheets of individual algarisms individually as time goes by.
3239     *
3240     * A newly created clock will fetch system's time (already
3241     * considering local time adjustments) to start with, and will tick
3242     * accondingly. It may or may not show seconds.
3243     *
3244     * Clocks have an @b edition mode. When in it, the sheets will
3245     * display extra arrow indications on the top and bottom and the
3246     * user may click on them to raise or lower the time values. After
3247     * it's told to exit edition mode, it will keep ticking with that
3248     * new time set (it keeps the difference from local time).
3249     *
3250     * Also, when under edition mode, user clicks on the cited arrows
3251     * which are @b held for some time will make the clock to flip the
3252     * sheet, thus editing the time, continuosly and automatically for
3253     * the user. The interval between sheet flips will keep growing in
3254     * time, so that it helps the user to reach a time which is distant
3255     * from the one set.
3256     *
3257     * The time display is, by default, in military mode (24h), but an
3258     * am/pm indicator may be optionally shown, too, when it will
3259     * switch to 12h.
3260     *
3261     * Smart callbacks one can register to:
3262     * - "changed" - the clock's user changed the time
3263     *
3264     * Here is an example on its usage:
3265     * @li @ref clock_example
3266     */
3267
3268    /**
3269     * @addtogroup Clock
3270     * @{
3271     */
3272
3273    /**
3274     * Identifiers for which clock digits should be editable, when a
3275     * clock widget is in edition mode. Values may be ORed together to
3276     * make a mask, naturally.
3277     *
3278     * @see elm_clock_edit_set()
3279     * @see elm_clock_digit_edit_set()
3280     */
3281    typedef enum _Elm_Clock_Digedit
3282      {
3283         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3284         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3285         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
3286         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3287         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
3288         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3289         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
3290         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
3291      } Elm_Clock_Digedit;
3292
3293    /**
3294     * Add a new clock widget to the given parent Elementary
3295     * (container) object
3296     *
3297     * @param parent The parent object
3298     * @return a new clock widget handle or @c NULL, on errors
3299     *
3300     * This function inserts a new clock widget on the canvas.
3301     *
3302     * @ingroup Clock
3303     */
3304    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3305
3306    /**
3307     * Set a clock widget's time, programmatically
3308     *
3309     * @param obj The clock widget object
3310     * @param hrs The hours to set
3311     * @param min The minutes to set
3312     * @param sec The secondes to set
3313     *
3314     * This function updates the time that is showed by the clock
3315     * widget.
3316     *
3317     *  Values @b must be set within the following ranges:
3318     * - 0 - 23, for hours
3319     * - 0 - 59, for minutes
3320     * - 0 - 59, for seconds,
3321     *
3322     * even if the clock is not in "military" mode.
3323     *
3324     * @warning The behavior for values set out of those ranges is @b
3325     * indefined.
3326     *
3327     * @ingroup Clock
3328     */
3329    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
3330
3331    /**
3332     * Get a clock widget's time values
3333     *
3334     * @param obj The clock object
3335     * @param[out] hrs Pointer to the variable to get the hours value
3336     * @param[out] min Pointer to the variable to get the minutes value
3337     * @param[out] sec Pointer to the variable to get the seconds value
3338     *
3339     * This function gets the time set for @p obj, returning
3340     * it on the variables passed as the arguments to function
3341     *
3342     * @note Use @c NULL pointers on the time values you're not
3343     * interested in: they'll be ignored by the function.
3344     *
3345     * @ingroup Clock
3346     */
3347    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
3348
3349    /**
3350     * Set whether a given clock widget is under <b>edition mode</b> or
3351     * under (default) displaying-only mode.
3352     *
3353     * @param obj The clock object
3354     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
3355     * put it back to "displaying only" mode
3356     *
3357     * This function makes a clock's time to be editable or not <b>by
3358     * user interaction</b>. When in edition mode, clocks @b stop
3359     * ticking, until one brings them back to canonical mode. The
3360     * elm_clock_digit_edit_set() function will influence which digits
3361     * of the clock will be editable. By default, all of them will be
3362     * (#ELM_CLOCK_NONE).
3363     *
3364     * @note am/pm sheets, if being shown, will @b always be editable
3365     * under edition mode.
3366     *
3367     * @see elm_clock_edit_get()
3368     *
3369     * @ingroup Clock
3370     */
3371    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3372
3373    /**
3374     * Retrieve whether a given clock widget is under <b>edition
3375     * mode</b> or under (default) displaying-only mode.
3376     *
3377     * @param obj The clock object
3378     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
3379     * otherwise
3380     *
3381     * This function retrieves whether the clock's time can be edited
3382     * or not by user interaction.
3383     *
3384     * @see elm_clock_edit_set() for more details
3385     *
3386     * @ingroup Clock
3387     */
3388    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3389
3390    /**
3391     * Set what digits of the given clock widget should be editable
3392     * when in edition mode.
3393     *
3394     * @param obj The clock object
3395     * @param digedit Bit mask indicating the digits to be editable
3396     * (values in #Elm_Clock_Digedit).
3397     *
3398     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
3399     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
3400     * EINA_FALSE).
3401     *
3402     * @see elm_clock_digit_edit_get()
3403     *
3404     * @ingroup Clock
3405     */
3406    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
3407
3408    /**
3409     * Retrieve what digits of the given clock widget should be
3410     * editable when in edition mode.
3411     *
3412     * @param obj The clock object
3413     * @return Bit mask indicating the digits to be editable
3414     * (values in #Elm_Clock_Digedit).
3415     *
3416     * @see elm_clock_digit_edit_set() for more details
3417     *
3418     * @ingroup Clock
3419     */
3420    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3421
3422    /**
3423     * Set if the given clock widget must show hours in military or
3424     * am/pm mode
3425     *
3426     * @param obj The clock object
3427     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
3428     * to military mode
3429     *
3430     * This function sets if the clock must show hours in military or
3431     * am/pm mode. In some countries like Brazil the military mode
3432     * (00-24h-format) is used, in opposition to the USA, where the
3433     * am/pm mode is more commonly used.
3434     *
3435     * @see elm_clock_show_am_pm_get()
3436     *
3437     * @ingroup Clock
3438     */
3439    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
3440
3441    /**
3442     * Get if the given clock widget shows hours in military or am/pm
3443     * mode
3444     *
3445     * @param obj The clock object
3446     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
3447     * military
3448     *
3449     * This function gets if the clock shows hours in military or am/pm
3450     * mode.
3451     *
3452     * @see elm_clock_show_am_pm_set() for more details
3453     *
3454     * @ingroup Clock
3455     */
3456    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3457
3458    /**
3459     * Set if the given clock widget must show time with seconds or not
3460     *
3461     * @param obj The clock object
3462     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
3463     *
3464     * This function sets if the given clock must show or not elapsed
3465     * seconds. By default, they are @b not shown.
3466     *
3467     * @see elm_clock_show_seconds_get()
3468     *
3469     * @ingroup Clock
3470     */
3471    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
3472
3473    /**
3474     * Get whether the given clock widget is showing time with seconds
3475     * or not
3476     *
3477     * @param obj The clock object
3478     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
3479     *
3480     * This function gets whether @p obj is showing or not the elapsed
3481     * seconds.
3482     *
3483     * @see elm_clock_show_seconds_set()
3484     *
3485     * @ingroup Clock
3486     */
3487    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3488
3489    /**
3490     * Set the interval on time updates for an user mouse button hold
3491     * on clock widgets' time edition.
3492     *
3493     * @param obj The clock object
3494     * @param interval The (first) interval value in seconds
3495     *
3496     * This interval value is @b decreased while the user holds the
3497     * mouse pointer either incrementing or decrementing a given the
3498     * clock digit's value.
3499     *
3500     * This helps the user to get to a given time distant from the
3501     * current one easier/faster, as it will start to flip quicker and
3502     * quicker on mouse button holds.
3503     *
3504     * The calculation for the next flip interval value, starting from
3505     * the one set with this call, is the previous interval divided by
3506     * 1.05, so it decreases a little bit.
3507     *
3508     * The default starting interval value for automatic flips is
3509     * @b 0.85 seconds.
3510     *
3511     * @see elm_clock_interval_get()
3512     *
3513     * @ingroup Clock
3514     */
3515    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3516
3517    /**
3518     * Get the interval on time updates for an user mouse button hold
3519     * on clock widgets' time edition.
3520     *
3521     * @param obj The clock object
3522     * @return The (first) interval value, in seconds, set on it
3523     *
3524     * @see elm_clock_interval_set() for more details
3525     *
3526     * @ingroup Clock
3527     */
3528    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3529
3530    /**
3531     * @}
3532     */
3533
3534    /* layout */
3535    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3536    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
3537    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
3538    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3539    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3540    EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3541    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
3542    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
3543    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3544    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3545    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
3546    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
3547    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
3548    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3549    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);
3550    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
3551    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3552    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3553    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
3554    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
3555    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
3556    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3557    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3558    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
3559    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3560    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);
3561    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3562 /**
3563  * @def elm_layout_icon_set
3564  * Convienience macro to set the icon object in a layout that follows the
3565  * Elementary naming convention for its parts.
3566  *
3567  * @ingroup Layout
3568  */
3569 #define elm_layout_icon_set(_ly, _obj) \
3570   do { \
3571     const char *sig; \
3572     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
3573     if ((_obj)) sig = "elm,state,icon,visible"; \
3574     else sig = "elm,state,icon,hidden"; \
3575     elm_object_signal_emit((_ly), sig, "elm"); \
3576   } while (0)
3577
3578 /**
3579  * @def elm_layout_icon_get
3580  * Convienience macro to get the icon object from a layout that follows the
3581  * Elementary naming convention for its parts.
3582  *
3583  * @ingroup Layout
3584  */
3585 #define elm_layout_icon_get(_ly) \
3586   elm_layout_content_get((_ly), "elm.swallow.icon")
3587
3588 /**
3589  * @def elm_layout_end_set
3590  * Convienience macro to set the end object in a layout that follows the
3591  * Elementary naming convention for its parts.
3592  *
3593  * @ingroup Layout
3594  */
3595 #define elm_layout_end_set(_ly, _obj) \
3596   do { \
3597     const char *sig; \
3598     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
3599     if ((_obj)) sig = "elm,state,end,visible"; \
3600     else sig = "elm,state,end,hidden"; \
3601     elm_object_signal_emit((_ly), sig, "elm"); \
3602   } while (0)
3603
3604 /**
3605  * @def elm_layout_end_get
3606  * Convienience macro to get the end object in a layout that follows the
3607  * Elementary naming convention for its parts.
3608  *
3609  * @ingroup Layout
3610  */
3611 #define elm_layout_end_get(_ly) \
3612   elm_layout_content_get((_ly), "elm.swallow.end")
3613
3614 /**
3615  * @def elm_layout_label_set
3616  * Convienience macro to set the label in a layout that follows the
3617  * Elementary naming convention for its parts.
3618  *
3619  * @ingroup Layout
3620  * @deprecate use elm_object_text_* instead.
3621  */
3622 #define elm_layout_label_set(_ly, _txt) \
3623   elm_layout_text_set((_ly), "elm.text", (_txt))
3624
3625 /**
3626  * @def elm_layout_label_get
3627  * Convienience macro to get the label in a layout that follows the
3628  * Elementary naming convention for its parts.
3629  *
3630  * @ingroup Layout
3631  * @deprecate use elm_object_text_* instead.
3632  */
3633 #define elm_layout_label_get(_ly) \
3634   elm_layout_text_get((_ly), "elm.text")
3635
3636    /* smart callbacks called:
3637     */
3638
3639    /* notify */
3640    typedef enum _Elm_Notify_Orient
3641      {
3642         ELM_NOTIFY_ORIENT_TOP,
3643         ELM_NOTIFY_ORIENT_CENTER,
3644         ELM_NOTIFY_ORIENT_BOTTOM,
3645         ELM_NOTIFY_ORIENT_LEFT,
3646         ELM_NOTIFY_ORIENT_RIGHT,
3647         ELM_NOTIFY_ORIENT_TOP_LEFT,
3648         ELM_NOTIFY_ORIENT_TOP_RIGHT,
3649         ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
3650         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
3651         ELM_NOTIFY_ORIENT_LAST
3652      } Elm_Notify_Orient;
3653    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3654    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3655    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3656    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3657    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3658    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3659    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
3660    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3661    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3662    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3663    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
3664    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3665    /* smart callbacks called:
3666     * "timeout" - when timeout happens on notify and it's hidden
3667     * "block,clicked" - when it's hidden by a click outside of the notify's view
3668     */
3669
3670    /* hover */
3671    typedef enum _Elm_Hover_Axis
3672      {
3673         ELM_HOVER_AXIS_NONE,
3674         ELM_HOVER_AXIS_HORIZONTAL,
3675         ELM_HOVER_AXIS_VERTICAL,
3676         ELM_HOVER_AXIS_BOTH
3677      } Elm_Hover_Axis;
3678    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3679    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
3680    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3681    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3682    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3683    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3684    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3685    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3686    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
3687    /* available styles:
3688     * default
3689     * popout
3690     * menu
3691     * hoversel_vertical
3692     */
3693    /* smart callbacks called:
3694     * "clicked" - the user clicked the empty space in the hover to dismiss
3695     * "smart,changed" - a content object placed under the "smart"
3696     *                   policy was replaced to a new slot direction.
3697     */
3698
3699    /* entry */
3700    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
3701    struct _Elm_Entry_Anchor_Info
3702      {
3703         const char *name;
3704         int         button;
3705         Evas_Coord  x, y, w, h;
3706      };
3707    typedef enum _Elm_Icon_Type
3708      {
3709         ELM_ICON_NONE,
3710         ELM_ICON_FILE,
3711         ELM_ICON_STANDARD
3712      } Elm_Icon_Type;
3713
3714    typedef enum _Elm_Input_Panel_Layout
3715      {
3716         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default 4x4 layout */
3717         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
3718         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
3719         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
3720         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
3721         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
3722         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
3723         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
3724         ELM_INPUT_PANEL_LAYOUT_CUSTOM_1 = 100,  /* Reserved for future use */
3725         ELM_INPUT_PANEL_LAYOUT_CUSTOM_2,
3726         ELM_INPUT_PANEL_LAYOUT_CUSTOM_3,
3727         ELM_INPUT_PANEL_LAYOUT_CUSTOM_4,
3728         ELM_INPUT_PANEL_LAYOUT_CUSTOM_5,
3729         ELM_INPUT_PANEL_LAYOUT_CUSTOM_6,
3730         ELM_INPUT_PANEL_LAYOUT_CUSTOM_7,
3731         ELM_INPUT_PANEL_LAYOUT_CUSTOM_8,
3732         ELM_INPUT_PANEL_LAYOUT_CUSTOM_9,
3733         ELM_INPUT_PANEL_LAYOUT_CUSTOM_10
3734      } Elm_Input_Panel_Layout;
3735
3736    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
3737
3738    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3739    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
3740    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3741    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
3742    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3743    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3744    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3745    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3746    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3747    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3748    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
3749    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3750    EINA_DEPRECATED EAPI void         elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
3751    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3752    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
3753    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3754    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
3755    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3756    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
3757    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
3758    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
3759    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
3760    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3761    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3762    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3763    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3764    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3765    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3766    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3767    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3768    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3769    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);
3770    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3771    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3772    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
3773    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
3774    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
3775    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3776    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);
3777    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3778    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3779    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);
3780    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);
3781    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);
3782    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
3783    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
3784    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
3785    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3786    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3787    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
3788    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
3789    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
3790    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
3791    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3792    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
3793    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3794    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
3795    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
3796    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
3797    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
3798    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
3799    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
3800    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
3801    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
3802    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
3803    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
3804    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
3805    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
3806    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
3807
3808    /* pre-made filters for entries */
3809    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
3810    struct _Elm_Entry_Filter_Limit_Size
3811      {
3812         int max_char_count;
3813         int max_byte_count;
3814      };
3815    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
3816    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
3817    struct _Elm_Entry_Filter_Accept_Set
3818      {
3819         const char *accepted;
3820         const char *rejected;
3821      };
3822    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
3823    EAPI void         elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3824    EAPI void         elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
3825    EAPI void         elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
3826    EAPI void         elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
3827    EAPI void         elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
3828    EAPI void         elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
3829    EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
3830    EAPI void         elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
3831    EAPI void         elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
3832
3833    EINA_DEPRECATED EAPI void         elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
3834    EINA_DEPRECATED EAPI Evas_Coord   elm_entry_wrap_width_get(const Evas_Object *obj);
3835    EINA_DEPRECATED EAPI void         elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
3836    EINA_DEPRECATED EAPI void         elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
3837    EINA_DEPRECATED EAPI void         elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
3838
3839    /* smart callbacks called:
3840     * "changed" - the text content changed
3841     * "selection,start" - the user started selecting text
3842     * "selection,changed" - the user modified the selection size/location
3843     * "selection,cleared" - the user cleared the selection
3844     * "selection,paste" - the user requested a paste of text
3845     * "selection,copy" - the user copied the text
3846     * "selection,cut" - the user cut the text
3847     * "cursor,changed" - the cursor changed position
3848     * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
3849     * "activated" - when the enter key is pressed (useful for single line)
3850     * "press" - when finger/mouse is pressed down
3851     * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
3852     * "clicked,double" - when finger/mouse is double-pressed
3853     * "longpressed" - the entry has been longpressed
3854     * "focused" - the entry has received keyboard focus
3855     * "unfocused" - keyboard focus is gone
3856     */
3857
3858    /* composite widgets - these basically put together basic widgets above
3859     * in convenient packages that do more than basic stuff */
3860
3861    /* anchorview */
3862    /**
3863     * @defgroup Anchorview Anchorview
3864     *
3865     * Anchorview is for displaying text that contains markup with anchors
3866     * like <c>\<a href=1234\>something\</\></c> in it.
3867     *
3868     * Besides being styled differently, the anchorview widget provides the
3869     * necessary functionality so that clicking on these anchors brings up a
3870     * popup with user defined content such as "call", "add to contacts" or
3871     * "open web page". This popup is provided using the @ref Hover widget.
3872     *
3873     * This widget is very similar to @ref Anchorblock, so refer to that
3874     * widget for an example. The only difference Anchorview has is that the
3875     * widget is already provided with scrolling functionality, so if the
3876     * text set to it is too large to fit in the given space, it will scroll,
3877     * whereas the @ref Anchorblock widget will keep growing to ensure all the
3878     * text can be displayed.
3879     *
3880     * This widget emits the following signals:
3881     * @li "anchor,clicked": will be called when an anchor is clicked. The
3882     * @p event_info parameter on the callback will be a pointer of type
3883     * ::Elm_Entry_Anchorview_Info.
3884     *
3885     * See @ref Anchorblock for an example on how to use both of them.
3886     *
3887     * @see Anchorblock
3888     * @see Entry
3889     * @see Hover
3890     *
3891     * @{
3892     */
3893    /**
3894     * @typedef Elm_Entry_Anchorview_Info
3895     *
3896     * The info sent in the callback for "anchor,clicked" signals emitted by
3897     * the Anchorview widget.
3898     */
3899    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
3900    /**
3901     * @struct _Elm_Entry_Anchorview_Info
3902     *
3903     * The info sent in the callback for "anchor,clicked" signals emitted by
3904     * the Anchorview widget.
3905     */
3906    struct _Elm_Entry_Anchorview_Info
3907      {
3908         const char     *name; /**< Name of the anchor, as indicated in its href
3909                                    attribute */
3910         int             button; /**< The mouse button used to click on it */
3911         Evas_Object    *hover; /**< The hover object to use for the popup */
3912         struct {
3913              Evas_Coord    x, y, w, h;
3914         } anchor, /**< Geometry selection of text used as anchor */
3915           hover_parent; /**< Geometry of the object used as parent by the
3916                              hover */
3917         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
3918                                              for content on the left side of
3919                                              the hover. Before calling the
3920                                              callback, the widget will make the
3921                                              necessary calculations to check
3922                                              which sides are fit to be set with
3923                                              content, based on the position the
3924                                              hover is activated and its distance
3925                                              to the edges of its parent object
3926                                              */
3927         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
3928                                               the right side of the hover.
3929                                               See @ref hover_left */
3930         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
3931                                             of the hover. See @ref hover_left */
3932         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
3933                                                below the hover. See @ref
3934                                                hover_left */
3935      };
3936    /**
3937     * Add a new Anchorview object
3938     *
3939     * @param parent The parent object
3940     * @return The new object or NULL if it cannot be created
3941     */
3942    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3943    /**
3944     * Set the text to show in the anchorview
3945     *
3946     * Sets the text of the anchorview to @p text. This text can include markup
3947     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
3948     * text that will be specially styled and react to click events, ended with
3949     * either of \</a\> or \</\>. When clicked, the anchor will emit an
3950     * "anchor,clicked" signal that you can attach a callback to with
3951     * evas_object_smart_callback_add(). The name of the anchor given in the
3952     * event info struct will be the one set in the href attribute, in this
3953     * case, anchorname.
3954     *
3955     * Other markup can be used to style the text in different ways, but it's
3956     * up to the style defined in the theme which tags do what.
3957     * @deprecated use elm_object_text_set() instead.
3958     */
3959    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
3960    /**
3961     * Get the markup text set for the anchorview
3962     *
3963     * Retrieves the text set on the anchorview, with markup tags included.
3964     *
3965     * @param obj The anchorview object
3966     * @return The markup text set or @c NULL if nothing was set or an error
3967     * occurred
3968     * @deprecated use elm_object_text_set() instead.
3969     */
3970    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3971    /**
3972     * Set the parent of the hover popup
3973     *
3974     * Sets the parent object to use by the hover created by the anchorview
3975     * when an anchor is clicked. See @ref Hover for more details on this.
3976     * If no parent is set, the same anchorview object will be used.
3977     *
3978     * @param obj The anchorview object
3979     * @param parent The object to use as parent for the hover
3980     */
3981    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3982    /**
3983     * Get the parent of the hover popup
3984     *
3985     * Get the object used as parent for the hover created by the anchorview
3986     * widget. See @ref Hover for more details on this.
3987     *
3988     * @param obj The anchorview object
3989     * @return The object used as parent for the hover, NULL if none is set.
3990     */
3991    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3992    /**
3993     * Set the style that the hover should use
3994     *
3995     * When creating the popup hover, anchorview will request that it's
3996     * themed according to @p style.
3997     *
3998     * @param obj The anchorview object
3999     * @param style The style to use for the underlying hover
4000     *
4001     * @see elm_object_style_set()
4002     */
4003    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4004    /**
4005     * Get the style that the hover should use
4006     *
4007     * Get the style the hover created by anchorview will use.
4008     *
4009     * @param obj The anchorview object
4010     * @return The style to use by the hover. NULL means the default is used.
4011     *
4012     * @see elm_object_style_set()
4013     */
4014    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4015    /**
4016     * Ends the hover popup in the anchorview
4017     *
4018     * When an anchor is clicked, the anchorview widget will create a hover
4019     * object to use as a popup with user provided content. This function
4020     * terminates this popup, returning the anchorview to its normal state.
4021     *
4022     * @param obj The anchorview object
4023     */
4024    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4025    /**
4026     * Set bouncing behaviour when the scrolled content reaches an edge
4027     *
4028     * Tell the internal scroller object whether it should bounce or not
4029     * when it reaches the respective edges for each axis.
4030     *
4031     * @param obj The anchorview object
4032     * @param h_bounce Whether to bounce or not in the horizontal axis
4033     * @param v_bounce Whether to bounce or not in the vertical axis
4034     *
4035     * @see elm_scroller_bounce_set()
4036     */
4037    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4038    /**
4039     * Get the set bouncing behaviour of the internal scroller
4040     *
4041     * Get whether the internal scroller should bounce when the edge of each
4042     * axis is reached scrolling.
4043     *
4044     * @param obj The anchorview object
4045     * @param h_bounce Pointer where to store the bounce state of the horizontal
4046     *                 axis
4047     * @param v_bounce Pointer where to store the bounce state of the vertical
4048     *                 axis
4049     *
4050     * @see elm_scroller_bounce_get()
4051     */
4052    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4053    /**
4054     * Appends a custom item provider to the given anchorview
4055     *
4056     * Appends the given function to the list of items providers. This list is
4057     * called, one function at a time, with the given @p data pointer, the
4058     * anchorview object and, in the @p item parameter, the item name as
4059     * referenced in its href string. Following functions in the list will be
4060     * called in order until one of them returns something different to NULL,
4061     * which should be an Evas_Object which will be used in place of the item
4062     * element.
4063     *
4064     * Items in the markup text take the form \<item relsize=16x16 vsize=full
4065     * href=item/name\>\</item\>
4066     *
4067     * @param obj The anchorview object
4068     * @param func The function to add to the list of providers
4069     * @param data User data that will be passed to the callback function
4070     *
4071     * @see elm_entry_item_provider_append()
4072     */
4073    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);
4074    /**
4075     * Prepend a custom item provider to the given anchorview
4076     *
4077     * Like elm_anchorview_item_provider_append(), but it adds the function
4078     * @p func to the beginning of the list, instead of the end.
4079     *
4080     * @param obj The anchorview object
4081     * @param func The function to add to the list of providers
4082     * @param data User data that will be passed to the callback function
4083     */
4084    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);
4085    /**
4086     * Remove a custom item provider from the list of the given anchorview
4087     *
4088     * Removes the function and data pairing that matches @p func and @p data.
4089     * That is, unless the same function and same user data are given, the
4090     * function will not be removed from the list. This allows us to add the
4091     * same callback several times, with different @p data pointers and be
4092     * able to remove them later without conflicts.
4093     *
4094     * @param obj The anchorview object
4095     * @param func The function to remove from the list
4096     * @param data The data matching the function to remove from the list
4097     */
4098    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);
4099    /**
4100     * @}
4101     */
4102
4103    /* anchorblock */
4104    /**
4105     * @defgroup Anchorblock Anchorblock
4106     *
4107     * Anchorblock is for displaying text that contains markup with anchors
4108     * like <c>\<a href=1234\>something\</\></c> in it.
4109     *
4110     * Besides being styled differently, the anchorblock widget provides the
4111     * necessary functionality so that clicking on these anchors brings up a
4112     * popup with user defined content such as "call", "add to contacts" or
4113     * "open web page". This popup is provided using the @ref Hover widget.
4114     *
4115     * This widget emits the following signals:
4116     * @li "anchor,clicked": will be called when an anchor is clicked. The
4117     * @p event_info parameter on the callback will be a pointer of type
4118     * ::Elm_Entry_Anchorblock_Info.
4119     *
4120     * @see Anchorview
4121     * @see Entry
4122     * @see Hover
4123     *
4124     * Since examples are usually better than plain words, we might as well
4125     * try @ref tutorial_anchorblock_example "one".
4126     */
4127    /**
4128     * @page tutorial_anchorblock_example Anchorblock/Anchorview example
4129     * This exampel will show both Anchorblock and @ref Anchorview,
4130     * since both are very similar and it's easier to show them once and side
4131     * by side, so the difference is more clear.
4132     *
4133     * We'll show the relevant snippets of the code here, but the full example
4134     * can be found here... sorry, @ref anchorblock_example_01.c "here".
4135     *
4136     * As for the actual example, it's just a simple window with an anchorblock
4137     * and an anchorview, both containing the same text. After including
4138     * Elementary.h and declaring some functions we'll need, we jump to our
4139     * elm_main (see ELM_MAIN) and create our window.
4140     * @dontinclude anchorblock_example_01.c
4141     * @skip int
4142     * @until const char
4143     * @until ;
4144     *
4145     * With the needed variables declared, we'll create the window and a box to
4146     * hold our widgets, but we don't need to go through that here.
4147     *
4148     * In order to make clear where the anchorblock ends and the anchorview
4149     * begins, they'll be each inside a @ref Frame. After creating the frame,
4150     * the anchorblock follows.
4151     * @skip elm_frame_add
4152     * @until elm_frame_content_set
4153     *
4154     * Nothing out of the ordinary there. What's worth mentioning is the call
4155     * to elm_anchorblock_hover_parent_set(). We are telling our widget that
4156     * when an anchor is clicked, the hover for the popup will cover the entire
4157     * window. This affects the area that will be obscured by the hover and
4158     * where clicking will dismiss it, as well as the calculations it does to
4159     * inform the best locations where to insert the popups content.
4160     * Other than that, the code is pretty standard. We also need to set our
4161     * callback for when an anchor is clicked, since it's our task to populate
4162     * the popup. There's no default for it.
4163     *
4164     * The anchorview is no different, we only change a few things so it looks
4165     * different.
4166     * @until elm_frame_content_set
4167     *
4168     * Then we run, so stuff works and close our main function in the usual way.
4169     * @until ELM_MAIN
4170     *
4171     * Now, a little note. Normally you would use either one of anchorblock or
4172     * anchorview, set your one callback to clicks and do your stuff in there.
4173     * In this example, however, there are a few tricks to make it easier to
4174     * show both widgets in one go (and to save me some typing). So we have
4175     * two callbacks, one per widget, that will call a common function to do
4176     * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
4177     * anchorview too, since both are equal, and passing a callback to use
4178     * for our buttons to end the hover, because each widget has a different
4179     * function for it.
4180     * @until _anchorview_clicked_cb
4181     * @until }
4182     *
4183     * The meat of our popup is in the following function. We check what kind
4184     * of menu we need to show, based on the name set to the anchor in the
4185     * markup text. If there's no type (something went wrong, no valid contact
4186     * in the address list) we are just putting a button that does nothing, but
4187     * it's perfectly reasonable to just end the hover and call it quits.
4188     *
4189     * Our popup will consist of one main button in the middle of our hover,
4190     * and possibly a secondary button and a list of other options. We'll create
4191     * first our main button and check what kind of popup we need afterwards.
4192     * @skip static void
4193     * @skip static void
4194     * @until eina_stringshare_add
4195     * @until }
4196     *
4197     * Each button has two callbacks, one is our hack to close the hover
4198     * properly based on which widget it belongs to, the other a simple
4199     * printf that will show the action with the anchors own data. This is
4200     * not how you would usually do it. Instead, the common case is to have
4201     * one callback for the button that will know which function to call to end
4202     * things, but since we are doing it this way it's worth noting that
4203     * smart callbacks will be called in reverse in respect to the order they
4204     * were added, and since our @c btn_end_cb will close the hover, and thus
4205     * delete our buttons, the other callback wouldn't be called if we had
4206     * added it before.
4207     *
4208     * After our telephone popup, there are a few others that are practically
4209     * the same, so they won't be shown here.
4210     *
4211     * Once we are done with that, it's time to place our actions into our
4212     * hover. Main button goes in the middle without much questioning, and then
4213     * we see if we have a secondary button and a box of extra options.
4214     * Because I said so, secondary button goes on either side and box of
4215     * options either on top or below the main one, but to choose which
4216     * exactly, we use the hints our callback info has, which saves us from
4217     * having to do the math and see which side has more space available, with
4218     * a little special case where we delete our extra stuff if there's nowhere
4219     * to place it.
4220     * @skip url:
4221     * @skip }
4222     * @skip evas_object_smart
4223     * @until evas_object_del(box)
4224     * @until }
4225     * @until }
4226     *
4227     * The example will look like this:
4228     * @image html screenshots/anchorblock_01.png
4229     * @image latex screenshots/anchorblock_01.eps
4230     *
4231     * @example anchorblock_example_01.c
4232     */
4233    /**
4234     * @addtogroup Anchorblock
4235     * @{
4236     */
4237    /**
4238     * @typedef Elm_Entry_Anchorblock_Info
4239     *
4240     * The info sent in the callback for "anchor,clicked" signals emitted by
4241     * the Anchorblock widget.
4242     */
4243    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
4244    /**
4245     * @struct _Elm_Entry_Anchorblock_Info
4246     *
4247     * The info sent in the callback for "anchor,clicked" signals emitted by
4248     * the Anchorblock widget.
4249     */
4250    struct _Elm_Entry_Anchorblock_Info
4251      {
4252         const char     *name; /**< Name of the anchor, as indicated in its href
4253                                    attribute */
4254         int             button; /**< The mouse button used to click on it */
4255         Evas_Object    *hover; /**< The hover object to use for the popup */
4256         struct {
4257              Evas_Coord    x, y, w, h;
4258         } anchor, /**< Geometry selection of text used as anchor */
4259           hover_parent; /**< Geometry of the object used as parent by the
4260                              hover */
4261         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
4262                                              for content on the left side of
4263                                              the hover. Before calling the
4264                                              callback, the widget will make the
4265                                              necessary calculations to check
4266                                              which sides are fit to be set with
4267                                              content, based on the position the
4268                                              hover is activated and its distance
4269                                              to the edges of its parent object
4270                                              */
4271         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
4272                                               the right side of the hover.
4273                                               See @ref hover_left */
4274         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
4275                                             of the hover. See @ref hover_left */
4276         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
4277                                                below the hover. See @ref
4278                                                hover_left */
4279      };
4280    /**
4281     * Add a new Anchorblock object
4282     *
4283     * @param parent The parent object
4284     * @return The new object or NULL if it cannot be created
4285     */
4286    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4287    /**
4288     * Set the text to show in the anchorblock
4289     *
4290     * Sets the text of the anchorblock to @p text. This text can include markup
4291     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4292     * of text that will be specially styled and react to click events, ended
4293     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4294     * "anchor,clicked" signal that you can attach a callback to with
4295     * evas_object_smart_callback_add(). The name of the anchor given in the
4296     * event info struct will be the one set in the href attribute, in this
4297     * case, anchorname.
4298     *
4299     * Other markup can be used to style the text in different ways, but it's
4300     * up to the style defined in the theme which tags do what.
4301     * @deprecated use elm_object_text_set() instead.
4302     */
4303    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4304    /**
4305     * Get the markup text set for the anchorblock
4306     *
4307     * Retrieves the text set on the anchorblock, with markup tags included.
4308     *
4309     * @param obj The anchorblock object
4310     * @return The markup text set or @c NULL if nothing was set or an error
4311     * occurred
4312     * @deprecated use elm_object_text_set() instead.
4313     */
4314    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4315    /**
4316     * Set the parent of the hover popup
4317     *
4318     * Sets the parent object to use by the hover created by the anchorblock
4319     * when an anchor is clicked. See @ref Hover for more details on this.
4320     *
4321     * @param obj The anchorblock object
4322     * @param parent The object to use as parent for the hover
4323     */
4324    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4325    /**
4326     * Get the parent of the hover popup
4327     *
4328     * Get the object used as parent for the hover created by the anchorblock
4329     * widget. See @ref Hover for more details on this.
4330     * If no parent is set, the same anchorblock object will be used.
4331     *
4332     * @param obj The anchorblock object
4333     * @return The object used as parent for the hover, NULL if none is set.
4334     */
4335    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4336    /**
4337     * Set the style that the hover should use
4338     *
4339     * When creating the popup hover, anchorblock will request that it's
4340     * themed according to @p style.
4341     *
4342     * @param obj The anchorblock object
4343     * @param style The style to use for the underlying hover
4344     *
4345     * @see elm_object_style_set()
4346     */
4347    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4348    /**
4349     * Get the style that the hover should use
4350     *
4351     * Get the style the hover created by anchorblock will use.
4352     *
4353     * @param obj The anchorblock object
4354     * @return The style to use by the hover. NULL means the default is used.
4355     *
4356     * @see elm_object_style_set()
4357     */
4358    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4359    /**
4360     * Ends the hover popup in the anchorblock
4361     *
4362     * When an anchor is clicked, the anchorblock widget will create a hover
4363     * object to use as a popup with user provided content. This function
4364     * terminates this popup, returning the anchorblock to its normal state.
4365     *
4366     * @param obj The anchorblock object
4367     */
4368    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4369    /**
4370     * Appends a custom item provider to the given anchorblock
4371     *
4372     * Appends the given function to the list of items providers. This list is
4373     * called, one function at a time, with the given @p data pointer, the
4374     * anchorblock object and, in the @p item parameter, the item name as
4375     * referenced in its href string. Following functions in the list will be
4376     * called in order until one of them returns something different to NULL,
4377     * which should be an Evas_Object which will be used in place of the item
4378     * element.
4379     *
4380     * Items in the markup text take the form \<item relsize=16x16 vsize=full
4381     * href=item/name\>\</item\>
4382     *
4383     * @param obj The anchorblock object
4384     * @param func The function to add to the list of providers
4385     * @param data User data that will be passed to the callback function
4386     *
4387     * @see elm_entry_item_provider_append()
4388     */
4389    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);
4390    /**
4391     * Prepend a custom item provider to the given anchorblock
4392     *
4393     * Like elm_anchorblock_item_provider_append(), but it adds the function
4394     * @p func to the beginning of the list, instead of the end.
4395     *
4396     * @param obj The anchorblock object
4397     * @param func The function to add to the list of providers
4398     * @param data User data that will be passed to the callback function
4399     */
4400    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);
4401    /**
4402     * Remove a custom item provider from the list of the given anchorblock
4403     *
4404     * Removes the function and data pairing that matches @p func and @p data.
4405     * That is, unless the same function and same user data are given, the
4406     * function will not be removed from the list. This allows us to add the
4407     * same callback several times, with different @p data pointers and be
4408     * able to remove them later without conflicts.
4409     *
4410     * @param obj The anchorblock object
4411     * @param func The function to remove from the list
4412     * @param data The data matching the function to remove from the list
4413     */
4414    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);
4415    /**
4416     * @}
4417     */
4418
4419    /**
4420     * @defgroup Bubble Bubble
4421     *
4422     * @brief The Bubble is a widget to show text similarly to how speech is
4423     * represented in comics.
4424     *
4425     * The bubble widget contains 5 important visual elements:
4426     * @li The frame is a rectangle with rounded rectangles and an "arrow".
4427     * @li The @p icon is an image to which the frame's arrow points to.
4428     * @li The @p label is a text which appears to the right of the icon if the
4429     * corner is "top_left" or "bottom_left" and is right aligned to the frame
4430     * otherwise.
4431     * @li The @p info is a text which appears to the right of the label. Info's
4432     * font is of a ligther color than label.
4433     * @li The @p content is an evas object that is shown inside the frame.
4434     *
4435     * The position of the arrow, icon, label and info depends on which corner is
4436     * selected. The four available corners are:
4437     * @li "top_left" - Default
4438     * @li "top_right"
4439     * @li "bottom_left"
4440     * @li "bottom_right"
4441     *
4442     * Signals that you can add callbacks for are:
4443     * @li "clicked" - This is called when a user has clicked the bubble.
4444     *
4445     * For an example of using a buble see @ref bubble_01_example_page "this".
4446     *
4447     * @{
4448     */
4449    /**
4450     * Add a new bubble to the parent
4451     *
4452     * @param parent The parent object
4453     * @return The new object or NULL if it cannot be created
4454     *
4455     * This function adds a text bubble to the given parent evas object.
4456     */
4457    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4458    /**
4459     * Set the label of the bubble
4460     *
4461     * @param obj The bubble object
4462     * @param label The string to set in the label
4463     *
4464     * This function sets the title of the bubble. Where this appears depends on
4465     * the selected corner.
4466     * @deprecated use elm_object_text_set() instead.
4467     */
4468    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4469    /**
4470     * Get the label of the bubble
4471     *
4472     * @param obj The bubble object
4473     * @return The string of set in the label
4474     *
4475     * This function gets the title of the bubble.
4476     * @deprecated use elm_object_text_set() instead.
4477     */
4478    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4479    /**
4480     * Set the info of the bubble
4481     *
4482     * @param obj The bubble object
4483     * @param info The given info about the bubble
4484     *
4485     * This function sets the info of the bubble. Where this appears depends on
4486     * the selected corner.
4487     * @deprecated use elm_object_text_set() instead.
4488     */
4489    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
4490    /**
4491     * Get the info of the bubble
4492     *
4493     * @param obj The bubble object
4494     *
4495     * @return The "info" string of the bubble
4496     *
4497     * This function gets the info text.
4498     * @deprecated use elm_object_text_set() instead.
4499     */
4500    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4501    /**
4502     * Set the content to be shown in the bubble
4503     *
4504     * Once the content object is set, a previously set one will be deleted.
4505     * If you want to keep the old content object, use the
4506     * elm_bubble_content_unset() function.
4507     *
4508     * @param obj The bubble object
4509     * @param content The given content of the bubble
4510     *
4511     * This function sets the content shown on the middle of the bubble.
4512     */
4513    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4514    /**
4515     * Get the content shown in the bubble
4516     *
4517     * Return the content object which is set for this widget.
4518     *
4519     * @param obj The bubble object
4520     * @return The content that is being used
4521     */
4522    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4523    /**
4524     * Unset the content shown in the bubble
4525     *
4526     * Unparent and return the content object which was set for this widget.
4527     *
4528     * @param obj The bubble object
4529     * @return The content that was being used
4530     */
4531    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4532    /**
4533     * Set the icon of the bubble
4534     *
4535     * Once the icon object is set, a previously set one will be deleted.
4536     * If you want to keep the old content object, use the
4537     * elm_icon_content_unset() function.
4538     *
4539     * @param obj The bubble object
4540     * @param icon The given icon for the bubble
4541     */
4542    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4543    /**
4544     * Get the icon of the bubble
4545     *
4546     * @param obj The bubble object
4547     * @return The icon for the bubble
4548     *
4549     * This function gets the icon shown on the top left of bubble.
4550     */
4551    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4552    /**
4553     * Unset the icon of the bubble
4554     *
4555     * Unparent and return the icon object which was set for this widget.
4556     *
4557     * @param obj The bubble object
4558     * @return The icon that was being used
4559     */
4560    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4561    /**
4562     * Set the corner of the bubble
4563     *
4564     * @param obj The bubble object.
4565     * @param corner The given corner for the bubble.
4566     *
4567     * This function sets the corner of the bubble. The corner will be used to
4568     * determine where the arrow in the frame points to and where label, icon and
4569     * info arre shown.
4570     *
4571     * Possible values for corner are:
4572     * @li "top_left" - Default
4573     * @li "top_right"
4574     * @li "bottom_left"
4575     * @li "bottom_right"
4576     */
4577    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
4578    /**
4579     * Get the corner of the bubble
4580     *
4581     * @param obj The bubble object.
4582     * @return The given corner for the bubble.
4583     *
4584     * This function gets the selected corner of the bubble.
4585     */
4586    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4587
4588    EINA_DEPRECATED EAPI void         elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
4589    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4590
4591    /**
4592     * @}
4593     */
4594
4595    /* photo */
4596    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4597    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4598    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4599    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
4600    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
4601    /* smart callbacks called:
4602     * "clicked" - the user clicked the icon
4603     * "drag,start" - Someone started dragging the image out of the object
4604     * "drag,end" - Dragged item was dropped (somewhere)
4605     */
4606
4607    /* gesture layer */
4608    /** @defgroup Elm_Gesture_Layer Gesture Layer */
4609    /**
4610     * @enum _Elm_Gesture_Types
4611     * Emum of supported gesture types.
4612     * @ingroup Elm_Gesture_Layer
4613     */
4614    enum _Elm_Gesture_Types
4615      {
4616         ELM_GESTURE_FIRST = 0,
4617
4618         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
4619         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
4620         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
4621
4622         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
4623
4624         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
4625         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
4626
4627         ELM_GESTURE_ZOOM, /**< Zoom */
4628         ELM_GESTURE_ROTATE, /**< Rotate */
4629
4630         ELM_GESTURE_LAST
4631      };
4632
4633    /**
4634     * @typedef Elm_Gesture_Types
4635     * Type for Emum of supported gesture types.
4636     * @ingroup Elm_Gesture_Layer
4637     */
4638    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
4639
4640    /**
4641     * @enum _Elm_Gesture_State
4642     * Emum of gesture states.
4643     * @ingroup Elm_Gesture_Layer
4644     */
4645    enum _Elm_Gesture_State
4646      {
4647         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
4648         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
4649         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
4650         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
4651         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
4652      };
4653    /**
4654     * @typedef Elm_Gesture_State
4655     * gesture states.
4656     * @ingroup Elm_Gesture_Layer
4657     */
4658    typedef enum _Elm_Gesture_State Elm_Gesture_State;
4659
4660    /**
4661     * @struct _Elm_Gesture_Taps_Info
4662     * Struct holds taps info for user
4663     * @ingroup Elm_Gesture_Layer
4664     */
4665    struct _Elm_Gesture_Taps_Info
4666      {
4667         Evas_Coord x, y;         /**< Holds center point between fingers */
4668         unsigned int n;          /**< Number of fingers tapped           */
4669         unsigned int timestamp;  /**< event timestamp       */
4670      };
4671
4672    /**
4673     * @typedef Elm_Gesture_Taps_Info
4674     * holds taps info for user
4675     * @ingroup Elm_Gesture_Layer
4676     */
4677    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
4678
4679    /**
4680     * @struct _Elm_Gesture_Momentum_Info
4681     * Struct holds momentum info for user
4682     * x1 and y1 are not necessarily in sync
4683     * x1 holds x value of x direction starting point
4684     * and same holds for y1.
4685     * This is noticeable when doing V-shape movement
4686     * @ingroup Elm_Gesture_Layer
4687     */
4688    struct _Elm_Gesture_Momentum_Info
4689      {  /* Report line ends, timestamps, and momentum computed        */
4690         Evas_Coord x1; /**< Final-swipe direction starting point on X */
4691         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
4692         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
4693         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
4694
4695         unsigned int tx; /**< Timestamp of start of final x-swipe */
4696         unsigned int ty; /**< Timestamp of start of final y-swipe */
4697
4698         Evas_Coord mx; /**< Momentum on X */
4699         Evas_Coord my; /**< Momentum on Y */
4700      };
4701
4702    /**
4703     * @typedef Elm_Gesture_Momentum_Info
4704     * holds momentum info for user
4705     * @ingroup Elm_Gesture_Layer
4706     */
4707     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
4708
4709    /**
4710     * @struct _Elm_Gesture_Line_Info
4711     * Struct holds line info for user
4712     * @ingroup Elm_Gesture_Layer
4713     */
4714    struct _Elm_Gesture_Line_Info
4715      {  /* Report line ends, timestamps, and momentum computed      */
4716         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
4717         unsigned int n;            /**< Number of fingers (lines)   */
4718         /* FIXME should be radians, bot degrees */
4719         double angle;              /**< Angle (direction) of lines  */
4720      };
4721
4722    /**
4723     * @typedef _Elm_Gesture_Line_Info
4724     * Holds line info for user
4725     * @ingroup Elm_Gesture_Layer
4726     */
4727     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
4728
4729    /**
4730     * @struct _Elm_Gesture_Zoom_Info
4731     * Struct holds zoom info for user
4732     * @ingroup Elm_Gesture_Layer
4733     */
4734    struct _Elm_Gesture_Zoom_Info
4735      {
4736         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
4737         Evas_Coord radius; /**< Holds radius between fingers reported to user */
4738         float zoom;            /**< Zoom value: 1.0 means no zoom             */
4739         float momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
4740      };
4741
4742    /**
4743     * @typedef Elm_Gesture_Zoom_Info
4744     * Holds zoom info for user
4745     * @ingroup Elm_Gesture_Layer
4746     */
4747    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
4748
4749    /**
4750     * @struct _Elm_Gesture_Rotate_Info
4751     * Struct holds rotation info for user
4752     * @ingroup Elm_Gesture_Layer
4753     */
4754    struct _Elm_Gesture_Rotate_Info
4755      {
4756         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
4757         Evas_Coord radius; /**< Holds radius between fingers reported to user */
4758         double base_angle; /**< Holds start-angle */
4759         double angle;      /**< Rotation value: 0.0 means no rotation         */
4760         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
4761      };
4762
4763    /**
4764     * @typedef Elm_Gesture_Rotate_Info
4765     * Holds rotation info for user
4766     * @ingroup Elm_Gesture_Layer
4767     */
4768    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
4769
4770    /**
4771     * @typedef Elm_Gesture_Event_Cb
4772     * User callback used to stream gesture info from gesture layer
4773     * @param data user data
4774     * @param event_info gesture report info
4775     * Returns a flag field to be applied on the causing event.
4776     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
4777     * upon the event, in an irreversible way.
4778     *
4779     * @ingroup Elm_Gesture_Layer
4780     */
4781    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
4782
4783    /**
4784     * Use function to set callbacks to be notified about
4785     * change of state of gesture.
4786     * When a user registers a callback with this function
4787     * this means this gesture has to be tested.
4788     *
4789     * When ALL callbacks for a gesture are set to NULL
4790     * it means user isn't interested in gesture-state
4791     * and it will not be tested.
4792     *
4793     * @param obj Pointer to gesture-layer.
4794     * @param idx The gesture you would like to track its state.
4795     * @param cb callback function pointer.
4796     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
4797     * @param data user info to be sent to callback (usually, Smart Data)
4798     *
4799     * @ingroup Elm_Gesture_Layer
4800     */
4801    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);
4802
4803    /**
4804     * Call this function to get repeat-events settings.
4805     *
4806     * @param obj Pointer to gesture-layer.
4807     *
4808     * @return repeat events settings.
4809     * @see elm_gesture_layer_hold_events_set()
4810     * @ingroup Elm_Gesture_Layer
4811     */
4812    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4813
4814    /**
4815     * This function called in order to make gesture-layer repeat events.
4816     * Set this of you like to get the raw events only if gestures were not detected.
4817     * Clear this if you like gesture layer to fwd events as testing gestures.
4818     *
4819     * @param obj Pointer to gesture-layer.
4820     * @param r Repeat: TRUE/FALSE
4821     *
4822     * @ingroup Elm_Gesture_Layer
4823     */
4824    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
4825
4826    /**
4827     * This function sets step-value for zoom action.
4828     * Set step to any positive value.
4829     * Cancel step setting by setting to 0.0
4830     *
4831     * @param obj Pointer to gesture-layer.
4832     * @param s new zoom step value.
4833     *
4834     * @ingroup Elm_Gesture_Layer
4835     */
4836    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4837
4838    /**
4839     * This function sets step-value for rotate action.
4840     * Set step to any positive value.
4841     * Cancel step setting by setting to 0.0
4842     *
4843     * @param obj Pointer to gesture-layer.
4844     * @param s new roatate step value.
4845     *
4846     * @ingroup Elm_Gesture_Layer
4847     */
4848    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
4849
4850    /**
4851     * This function called to attach gesture-layer to an Evas_Object.
4852     * @param obj Pointer to gesture-layer.
4853     * @param t Pointer to underlying object (AKA Target)
4854     *
4855     * @return TRUE, FALSE on success, failure.
4856     *
4857     * @ingroup Elm_Gesture_Layer
4858     */
4859    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
4860
4861    /**
4862     * Call this function to construct a new gesture-layer object.
4863     * This does not activate the gesture layer. You have to
4864     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
4865     *
4866     * @param parent the parent object.
4867     *
4868     * @return Pointer to new gesture-layer object.
4869     *
4870     * @ingroup Elm_Gesture_Layer
4871     */
4872    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4873
4874    /* thumb */
4875    typedef enum _Elm_Thumb_Animation_Setting
4876      {
4877         ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
4878         ELM_THUMB_ANIMATION_LOOP,      /* Keep playing animation until stop is requested */
4879         ELM_THUMB_ANIMATION_STOP,
4880         ELM_THUMB_ANIMATION_LAST
4881      } Elm_Thumb_Animation_Setting;
4882
4883    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4884    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
4885    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
4886    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4887    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
4888    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
4889    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4890    EAPI void                        *elm_thumb_ethumb_client_get(void);
4891    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
4892    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
4893    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4894    /* available styles:
4895     * default
4896     * noframe
4897     */
4898    /* smart callbacks called:
4899     * "clicked" - This is called when a user has clicked the thumb without dragging around.
4900     * "clicked,double" - This is called when a user has double-clicked the thumb.
4901     * "press" - This is called when a user has pressed down the thumb.
4902     * "generate,start" - The thumbnail generation started.
4903     * "generate,stop" - The generation process stopped.
4904     * "generate,error" - The generation failed.
4905     * "load,error" - The thumbnail image loading failed.
4906     */
4907
4908    /* hoversel */
4909    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4910    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4911    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4912    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4913    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4914    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4915    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4916    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4917    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4918    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4919    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4920    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4921    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4922    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4923    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4924    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);
4925    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
4926    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4927    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4928    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
4929    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);
4930    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);
4931    /* smart callbacks called:
4932     * "clicked" - the user clicked the hoversel button and popped up the sel
4933     * "selected" - an item in the hoversel list is selected
4934     * "dismissed" - the hover is dismissed
4935     */
4936
4937    /* toolbar */
4938    typedef enum _Elm_Toolbar_Shrink_Mode
4939      {
4940         ELM_TOOLBAR_SHRINK_NONE,   /**< set toolbar minimun size to fit all the items */
4941         ELM_TOOLBAR_SHRINK_HIDE,   /**< hide excess items */
4942         ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
4943         ELM_TOOLBAR_SHRINK_MENU    /**< inserts a button to pop up a menu with excess items */
4944      } Elm_Toolbar_Shrink_Mode;
4945
4946    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
4947    typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
4948
4949    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4950    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
4951    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4952    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4953    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4954    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4955    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4956    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);
4957    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);
4958    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);
4959    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);
4960    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4961    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4962    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4963    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4964    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4965    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
4966    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4967    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4968    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4969    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
4970    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4971    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
4972    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4973    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4974    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4975    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4976    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
4977    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4978    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4979    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4980    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4981    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
4982    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4983    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
4984    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4985    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4986    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4987    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
4988    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4989    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4990    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4991    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
4992    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4993    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
4994    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
4995    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);
4996    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
4997    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
4998    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
4999    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5000    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5001    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5002    EAPI void                    elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
5003    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);
5004    EAPI void                    elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5005    EAPI void                    elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5006    EAPI const char             *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5007    EAPI void                    elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5008    EAPI const char             *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5009    EAPI void                    elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5010    EAPI void                    elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5011    EAPI const char             *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5012    EAPI void                    elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5013    EAPI Eina_Bool               elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5014    /* smart callbacks called:
5015     * "clicked" - when the user clicks on a toolbar item and becomes selected
5016     */
5017    /* available styles:
5018     * default
5019     * transparent (no background or shadow, just show the provided content)
5020     */
5021
5022    /* tooltip */
5023    EAPI double       elm_tooltip_delay_get(void);
5024    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
5025    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
5026    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
5027    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
5028    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);
5029    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5030    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5031    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5032    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
5033    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5034    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5035    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5036    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5037    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5038    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5039
5040    /* cursors */
5041    EAPI int          elm_cursor_engine_only_get(void);
5042    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
5043
5044    /* menu */
5045    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
5046    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5047    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5048    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5049    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5050    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5051    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5052    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5053    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);
5054    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
5055    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5056    EAPI void               elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
5057    EAPI const char        *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5058    EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5059    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5060    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5061    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5062    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5063    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
5064    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5065    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5066    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5067    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5068    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
5069    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5070    EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5071    EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5072    EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5073    EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5074    EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5075
5076    /* smart callbacks called:
5077     * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
5078     */
5079
5080    /* list */
5081    typedef enum _Elm_List_Mode
5082      {
5083         ELM_LIST_COMPRESS = 0,
5084         ELM_LIST_SCROLL,
5085         ELM_LIST_LIMIT,
5086         ELM_LIST_EXPAND,
5087         ELM_LIST_LAST
5088      } Elm_List_Mode;
5089    typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
5090    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5091    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);
5092    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);
5093    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);
5094    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);
5095    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);
5096    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5097    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
5098    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5099    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5100    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5101    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5102    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5103    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5104    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5105    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5106    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5107    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5108    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5109    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
5110    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5111    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5112    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5113    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5114    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5115    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5116    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5117    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5118    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5119    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5120    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5121    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
5122    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5123    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5124    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5125    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5126    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5127    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5128    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);
5129    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5130    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5131    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5132    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5133    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5134    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5135    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5136    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5137    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5138    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5139    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5140    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5141    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5142    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5143    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5144    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);
5145    /* smart callbacks called:
5146     * "clicked,double" - when the user double-clicked an item
5147     * "selected" - when the user selected an item
5148     * "unselected" - when the user selected an item
5149     * "longpressed" - an item in the hoversel list is long-pressed
5150     * "scroll,edge,top" - the list is scrolled until the top edge
5151     * "scroll,edge,bottom" - the list is scrolled until the bottom edge
5152     * "scroll,edge,left" - the list is scrolled until the left edge
5153     * "scroll,edge,right" - the list is scrolled until the right edge
5154     */
5155
5156    /* slider */
5157    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5158    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5159    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5160    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5161    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5162    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5163    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
5164    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5165    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5166    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5167    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5168    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5169    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5170    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
5171    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5172   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);
5173   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);
5174    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5175    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5176    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5177    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5178    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5179    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5180    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5181    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5182    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
5183    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5184    /* smart callbacks called:
5185     * "changed" - Whenever the slider value is changed by the user.
5186     * "slider,drag,start" - dragging the slider indicator around has started
5187     * "slider,drag,stop" - dragging the slider indicator around has stopped
5188     * "delay,changed" - A short time after the value is changed by the user.
5189     *                   This will be called only when the user stops dragging for a very short
5190     *                   period or when they release their finger/mouse, so it avoids possibly
5191     *                   expensive reactions to the value change.
5192     */
5193
5194
5195    /* actionslider */
5196
5197    /**
5198     * @addtogroup Actionslider Actionslider
5199     *
5200     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
5201     * properties. The indicator is the element the user drags to choose a label.
5202     * When the position is set with magnet, when released the indicator will be
5203     * moved to it if it's nearest the magnetized position.
5204     *
5205     * @note By default all positions are set as enabled.
5206     *
5207     * Signals that you can add callbacks for are:
5208     *
5209     * "selected" - when user selects an enabled position (the label is passed
5210     *              as event info)".
5211     * @n
5212     * "pos_changed" - when the indicator reaches any of the positions("left",
5213     *                 "right" or "center").
5214     *
5215     * See an example of actionslider usage @ref actionslider_example_page "here"
5216     * @{
5217     */
5218
5219    typedef enum _Elm_Actionslider_Indicator_Pos
5220      {
5221         ELM_ACTIONSLIDER_INDICATOR_NONE,
5222         ELM_ACTIONSLIDER_INDICATOR_LEFT,
5223         ELM_ACTIONSLIDER_INDICATOR_RIGHT,
5224         ELM_ACTIONSLIDER_INDICATOR_CENTER
5225      } Elm_Actionslider_Indicator_Pos;
5226
5227    typedef enum _Elm_Actionslider_Magnet_Pos
5228      {
5229         ELM_ACTIONSLIDER_MAGNET_NONE = 0,
5230         ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
5231         ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
5232         ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
5233         ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
5234         ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
5235      } Elm_Actionslider_Magnet_Pos;
5236
5237    typedef enum _Elm_Actionslider_Label_Pos
5238      {
5239         ELM_ACTIONSLIDER_LABEL_LEFT,
5240         ELM_ACTIONSLIDER_LABEL_RIGHT,
5241         ELM_ACTIONSLIDER_LABEL_CENTER,
5242         ELM_ACTIONSLIDER_LABEL_BUTTON
5243      } Elm_Actionslider_Label_Pos;
5244
5245    /* smart callbacks called:
5246     * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
5247     */
5248
5249    /**
5250     * Add a new actionslider to the parent.
5251     *
5252     * @param parent The parent object
5253     * @return The new actionslider object or NULL if it cannot be created
5254     */
5255    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5256
5257    /**
5258    * Set actionslider label.
5259    *
5260    * @param[in] obj The actionslider object
5261    * @param[in] pos The position of the label.
5262    * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
5263    * @param label The label which is going to be set.
5264    */
5265    EAPI void               elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
5266    /**
5267     * Get actionslider labels.
5268     *
5269     * @param obj The actionslider object
5270     * @param left_label A char** to place the left_label of @p obj into.
5271     * @param center_label A char** to place the center_label of @p obj into.
5272     * @param right_label A char** to place the right_label of @p obj into.
5273     */
5274    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);
5275    /**
5276     * Get actionslider selected label.
5277     *
5278     * @param obj The actionslider object
5279     * @return The selected label
5280     */
5281    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5282    /**
5283     * Set actionslider indicator position.
5284     *
5285     * @param obj The actionslider object.
5286     * @param pos The position of the indicator.
5287     */
5288    EAPI void                elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
5289    /**
5290     * Get actionslider indicator position.
5291     *
5292     * @param obj The actionslider object.
5293     * @return The position of the indicator.
5294     */
5295    EAPI Elm_Actionslider_Indicator_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5296    /**
5297     * Set actionslider magnet position. To make multiple positions magnets @c or
5298     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
5299     *
5300     * @param obj The actionslider object.
5301     * @param pos Bit mask indicating the magnet positions.
5302     */
5303    EAPI void                elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5304    /**
5305     * Get actionslider magnet position.
5306     *
5307     * @param obj The actionslider object.
5308     * @return The positions with magnet property.
5309     */
5310    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5311    /**
5312     * Set actionslider enabled position. To set multiple positions as enabled @c or
5313     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
5314     *
5315     * @note All the positions are enabled by default.
5316     *
5317     * @param obj The actionslider object.
5318     * @param pos Bit mask indicating the enabled positions.
5319     */
5320    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5321    /**
5322     * Get actionslider enabled position.
5323     *
5324     * @param obj The actionslider object.
5325     * @return The enabled positions.
5326     */
5327    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5328    /**
5329     * Set the label used on the indicator.
5330     *
5331     * @param obj The actionslider object
5332     * @param label The label to be set on the indicator.
5333     * @deprecated use elm_object_text_set() instead.
5334     */
5335    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5336    /**
5337     * Get the label used on the indicator object.
5338     *
5339     * @param obj The actionslider object
5340     * @return The indicator label
5341     * @deprecated use elm_object_text_get() instead.
5342     */
5343    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5344
5345    /**
5346    * Hold actionslider object movement.
5347    *
5348    * @param[in] obj The actionslider object
5349    * @param[in] flag Actionslider hold/release
5350    * (EINA_TURE = hold/EIN_FALSE = release)
5351    *
5352    * @ingroup Actionslider
5353    */
5354    EAPI void                             elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
5355
5356
5357    /**
5358     *
5359     */
5360
5361    /* genlist */
5362    typedef enum _Elm_Genlist_Item_Flags
5363      {
5364         ELM_GENLIST_ITEM_NONE = 0,
5365         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
5366         ELM_GENLIST_ITEM_GROUP = (1 << 1)
5367      } Elm_Genlist_Item_Flags;
5368    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
5369    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
5370    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
5371    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5372    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
5373    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5374    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
5375    typedef void         (*GenlistItemMovedFunc)    ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
5376
5377    struct _Elm_Genlist_Item_Class
5378      {
5379         const char                *item_style;
5380         struct {
5381           GenlistItemLabelGetFunc  label_get;
5382           GenlistItemIconGetFunc   icon_get;
5383           GenlistItemStateGetFunc  state_get;
5384           GenlistItemDelFunc       del;
5385           GenlistItemMovedFunc     moved;
5386         } func;
5387         const char *edit_item_style;
5388         const char                *mode_item_style;
5389      };
5390    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5391    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5392    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5393    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5394    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5395    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5396    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5397    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5398    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5399    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5400    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
5401    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5402    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
5403    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5404    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5405    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5406    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5407    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5408    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
5409    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5410    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5411    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5412    /* operations to add items */
5413    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);
5414    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);
5415    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);
5416    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);
5417    /* operations to retrieve existing items */
5418    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5419    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5420    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5421    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);
5422    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5423    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5424    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5425    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);
5426    /* available item styles:
5427     * default
5428     * default_style - The text part is a textblock
5429     * double_label
5430     * icon_top_text_bottom
5431     */
5432    /* Genlist Item operation */
5433    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5434    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5435    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5436    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5437    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5438    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5439    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5440    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
5441    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5442    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5443    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5444    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5445    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
5446    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5447    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5448    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5449    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5450    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5451    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5452    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5453    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5454    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5455    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
5456    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5457    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5458    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5459    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
5460    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
5461    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);
5462    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5463    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5464    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5465    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5466    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5467    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5468    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5469    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5470    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5471    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5472    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
5473    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
5474    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5475    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5476    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5477    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5478    /* Signals that you can add callbacks for are:
5479     * "clicked,double" - This is called when a user has double-clicked an item.
5480     *                    The event_info parameter is the genlist item that was
5481     *                    double-clicked.
5482     * "selected" - This is called when a user has made an item selected. The
5483     *              event_info parameter is the genlist item that was selected.
5484     * "unselected" - This is called when a user has made an item unselected. The
5485     *                 event_info parameter is the genlist item that was unselected.
5486     * "expanded" - This is called when elm_genlist_item_expanded_set() is called
5487     *              and the item is now meant to be expanded. The event_info parameter is the
5488     *              genlist item that was indicated to expand. It is the job of this callback
5489     *              to then fill in the child items.
5490     * "contracted" - This is called when elm_genlist_item_expanded_set() is called
5491     *                and the item is now meant to be contracted. The event_info parameter is
5492     *                the genlist item that was indicated to contract. It is the job of this
5493     *                callback to then delete the child items.
5494     * "expand,request" - This is called when a user has indicated they want to
5495     *                    expand a tree branch item. The callback should decide if the item can
5496     *                    expand (has any children) and then call elm_genlist_item_expanded_set()
5497     *                    appropriately to set the state. The event_info parameter is the genlist
5498     *                    item that was indicated to expand.
5499     * "contract,request" - This is called when a user has indicated they want to
5500     *                      contract a tree branch item. The callback should decide if the item can
5501     *                      contract (has any children) and then call elm_genlist_item_expanded_set()
5502     *                      appropriately to set the state. The event_info parameter is the genlist
5503     *                      item that was indicated to contract.
5504     * "realized" - This is called when the item in the list is created as a real
5505     *              evas object. event_info parameter is the genlist item that was created.
5506     *              The object may be deleted at any time, so it is up to the caller to
5507     *              not use the object pointer from elm_genlist_item_object_get() in a way
5508     *              where it may point to freed objects.
5509     * "unrealized" - This is called just before an item is unrealized. After
5510     *                this call icon objects provided will be deleted and the item object
5511     *                itself delete or be put into a floating cache.
5512     * "drag,start,up" - This is called when the item in the list has been dragged
5513     *                   (not scrolled) up.
5514     * "drag,start,down" - This is called when the item in the list has been dragged
5515     *                     (not scrolled) down.
5516     * "drag,start,left" - This is called when the item in the list has been dragged i
5517     *                     (not scrolled) left.
5518     * "drag,start,right" - This is called when the item in the list has been dragged
5519     *                      (not scrolled) right.
5520     * "drag,stop" - This is called when the item in the list has stopped being
5521     *               dragged.
5522     * "drag" - This is called when the item in the list is being dragged.
5523     * "longpressed" - This is called when the item is pressed for a certain amount
5524     *                 of time. By default it's 1 second.
5525     * "scroll,edge,top" - This is called when the genlist is scrolled until the
5526     *                     top edge.
5527     * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
5528     *                         bottom edge.
5529     * "scroll,edge,left" - This is called when the genlist is scrolled until the
5530     *                      left edge.
5531     * "scroll,edge,right" - This is called when the genlist is scrolled until the
5532     *                       right edge.
5533     * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
5534     *                       left.
5535     * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
5536     *                       right.
5537     * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
5538     * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
5539     *                      down.
5540     * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
5541     *                     out.
5542     * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
5543     */
5544
5545    EAPI void               elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
5546    EAPI Eina_Bool          elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5547    EAPI void               elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
5548    EAPI Eina_Bool          elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5549    EAPI void               elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
5550    EAPI void               elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
5551    EAPI void               elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5552    EAPI void               elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5553    EAPI void               elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5554    EAPI Eina_Bool          elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5555
5556    /**
5557     * @page tutorial_check Check example
5558     * @dontinclude check_example_01.c
5559     *
5560     * This example will show 2 checkboxes, one with just a label and the second
5561     * one with both a label and an icon. This example also ilustrates how to
5562     * have the checkbox change the value of a variable and how to react to those
5563     * changes.
5564     *
5565     * We will start with the usual setup code:
5566     * @until show(bg)
5567     *
5568     * And now we create our first checkbox, set its label, tell it to change
5569     * the value of @p value when the checkbox stats is changed and ask to be
5570     * notified of state changes:
5571     * @until show
5572     *
5573     * For our second checkbox we are going to set an icon so we need to create
5574     * and icon:
5575     * @until show
5576     * @note For simplicity we are using a rectangle as icon, but any evas object
5577     * can be used.
5578     *
5579     * And for our second checkbox we set the label, icon and state to true:
5580     * @until show
5581     *
5582     * We now do some more setup:
5583     * @until ELM_MAIN
5584     *
5585     * And finally implement the callback that will be called when the first
5586     * checkbox's state changes. This callback will use @p data to print a
5587     * message:
5588     * @until }
5589     * @note This work because @p data is @p value(from the main function) and @p
5590     * value is changed when the checkbox is changed.
5591     *
5592     * Our example will look like this:
5593     * @image html screenshots/check_example_01.png
5594     * @image latex screenshots/check_example_01.eps
5595     *
5596     * @example check_example_01.c
5597     */
5598    /**
5599     * @defgroup Check Check
5600     *
5601     * @brief The check widget allows for toggling a value between true and
5602     * false.
5603     *
5604     * Check objects are a lot like radio objects in layout and functionality
5605     * except they do not work as a group, but independently and only toggle the
5606     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
5607     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
5608     * returns the current state. For convenience, like the radio objects, you
5609     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
5610     * for it to modify.
5611     *
5612     * Signals that you can add callbacks for are:
5613     * "changed" - This is called whenever the user changes the state of one of
5614     *             the check object(event_info is NULL).
5615     *
5616     * @ref tutorial_check should give you a firm grasp of how to use this widget.
5617     * @{
5618     */
5619    /**
5620     * @brief Add a new Check object
5621     *
5622     * @param parent The parent object
5623     * @return The new object or NULL if it cannot be created
5624     */
5625    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5626    /**
5627     * @brief Set the text label of the check object
5628     *
5629     * @param obj The check object
5630     * @param label The text label string in UTF-8
5631     *
5632     * @deprecated use elm_object_text_set() instead.
5633     */
5634    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5635    /**
5636     * @brief Get the text label of the check object
5637     *
5638     * @param obj The check object
5639     * @return The text label string in UTF-8
5640     *
5641     * @deprecated use elm_object_text_get() instead.
5642     */
5643    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5644    /**
5645     * @brief Set the icon object of the check object
5646     *
5647     * @param obj The check object
5648     * @param icon The icon object
5649     *
5650     * Once the icon object is set, a previously set one will be deleted.
5651     * If you want to keep that old content object, use the
5652     * elm_check_icon_unset() function.
5653     */
5654    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5655    /**
5656     * @brief Get the icon object of the check object
5657     *
5658     * @param obj The check object
5659     * @return The icon object
5660     */
5661    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5662    /**
5663     * @brief Unset the icon used for the check object
5664     *
5665     * @param obj The check object
5666     * @return The icon object that was being used
5667     *
5668     * Unparent and return the icon object which was set for this widget.
5669     */
5670    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5671    /**
5672     * @brief Set the on/off state of the check object
5673     *
5674     * @param obj The check object
5675     * @param state The state to use (1 == on, 0 == off)
5676     *
5677     * This sets the state of the check. If set
5678     * with elm_check_state_pointer_set() the state of that variable is also
5679     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
5680     */
5681    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5682    /**
5683     * @brief Get the state of the check object
5684     *
5685     * @param obj The check object
5686     * @return The boolean state
5687     */
5688    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5689    /**
5690     * @brief Set a convenience pointer to a boolean to change
5691     *
5692     * @param obj The check object
5693     * @param statep Pointer to the boolean to modify
5694     *
5695     * This sets a pointer to a boolean, that, in addition to the check objects
5696     * state will also be modified directly. To stop setting the object pointed
5697     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
5698     * then when this is called, the check objects state will also be modified to
5699     * reflect the value of the boolean @p statep points to, just like calling
5700     * elm_check_state_set().
5701     */
5702    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5703    /**
5704     * @}
5705     */
5706
5707    /* radio */
5708    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5709    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5710    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5711    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5712    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5713    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5714    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
5715    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5716    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5717    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
5718    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5719    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
5720    /* smart callbacks called:
5721     * "changed" - when the radio status is changed
5722     */
5723
5724    /* pager */
5725    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5726    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5727    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
5728    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5729    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5730    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5731    EAPI void         elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
5732    EAPI void         elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
5733
5734    /* available item styles:
5735     * default
5736     * fade
5737     * fade_translucide
5738     * fade_invisible
5739     */
5740    /* smart callbacks called:
5741     * "hide,finished" - when the previous page is hided
5742     */
5743
5744    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
5745    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
5746    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
5747    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
5748    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
5749
5750    struct _Elm_Slideshow_Item_Class
5751      {
5752         struct _Elm_Slideshow_Item_Class_Func
5753           {
5754              SlideshowItemGetFunc get;
5755              SlideshowItemDelFunc del;
5756           } func;
5757      };
5758
5759    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5760    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
5761    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);
5762    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5763    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
5764    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
5765    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5766    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
5767    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5768    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5769    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5770    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
5771    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5772    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5773    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5774    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5775    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
5776    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5777    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
5778    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
5779    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5780    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
5781    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5782    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5783    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5784    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
5785    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5786    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5787    /* smart callbacks called:
5788     * "changed" - when the slideshow switch to another item
5789     */
5790
5791    /* file selector */
5792    typedef enum _Elm_Fileselector_Mode
5793      {
5794         ELM_FILESELECTOR_LIST = 0,
5795         ELM_FILESELECTOR_GRID,
5796         ELM_FILESELECTOR_LAST
5797      } Elm_Fileselector_Mode;
5798
5799    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5800    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
5801    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5802    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
5803    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5804    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
5805    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5806    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5807    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
5808    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5809    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5810    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5811    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5812    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
5813    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5814    /* smart callbacks called:
5815     * "selected" - the user click on a file
5816     * "directory,open" - the list is populate with a new content. event_info is a directory.
5817     * "done" - the user click on the ok or cancel buttons
5818     */
5819
5820    /* progressbar */
5821    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5822    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
5823    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5824    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5825    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5826    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5827    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5828    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5829    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5830    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5831    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5832    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5833    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5834    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5835    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5836    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5837    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5838    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5839    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5840    /* smart callbacks called:
5841     */
5842    /* available item styles:
5843     * default
5844     * wheel (simple style, no text, no progression, only pulse is available)
5845     */
5846
5847    /* separator */
5848    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5849    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5850    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5851    /* smart callbacks called:
5852     */
5853
5854    /* spinner */
5855    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5856    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
5857    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5858    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5859    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5860    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
5861    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5862    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5863    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5864    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
5865    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5866    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
5867    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5868    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
5869    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5870    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5871    /* smart callbacks called:
5872     * "changed" - when the spinner value changes
5873     * "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).
5874     */
5875    /* available item styles:
5876     * default
5877     * vertical (two up/down buttons at the right side and text left aligned)
5878     */
5879
5880    /* index */
5881    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
5882
5883    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5884    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
5885    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5886    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5887    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5888    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5889    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5890    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
5891    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5892    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
5893    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);
5894    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5895    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
5896    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5897    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
5898    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5899    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
5900    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5901    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
5902    EAPI void            elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
5903    /* smart callbacks called:
5904     * "changed" - when the selected index item changes
5905     * "delay,changed" - when the selected index item changes, but after some small idle period
5906     * "selected" - when the user releases a finger and selects an item
5907     * "level,up" - when the user moves a finger from the first level to the second level
5908     * "level,down" - when the user moves a finger from the second level to the first level
5909     */
5910
5911    /* photocam */
5912    typedef enum _Elm_Photocam_Zoom_Mode
5913      {
5914         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
5915         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
5916         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
5917         ELM_PHOTOCAM_ZOOM_MODE_LAST
5918      } Elm_Photocam_Zoom_Mode;
5919
5920    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5921    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
5922    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5923    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
5924    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5925    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
5926    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5927    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5928    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5929    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5930    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5931    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
5932    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5933    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5934    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5935    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5936    /* smart callbacks called:
5937     * "clicked" - when image clicked
5938     * "press" - when mouse/finger held down initially on image
5939     * "longpressed" - when mouse/finger held for long time on image
5940     * "clicked,double" - when mouse/finger double-clicked
5941     * "load" - when photo load begins
5942     * "loaded" - when photo load done
5943     * "load,detail" - when detailed image load begins
5944     * "loaded,detail" - when detailed image load done
5945     * "zoom,start" - when zooming started
5946     * "zoom,stop" - when zooming stopped
5947     * "zoom,change" - when auto zoom mode changed zoom level
5948     * "scroll - the content has been scrolled (moved)
5949     * "scroll,anim,start" - scrolling animation has started
5950     * "scroll,anim,stop" - scrolling animation has stopped
5951     * "scroll,drag,start" - dragging the contents around has started
5952     * "scroll,drag,stop" - dragging the contents around has stopped
5953     */
5954
5955    /* map */
5956    typedef enum _Elm_Map_Zoom_Mode
5957      {
5958         ELM_MAP_ZOOM_MODE_MANUAL,
5959         ELM_MAP_ZOOM_MODE_AUTO_FIT,
5960         ELM_MAP_ZOOM_MODE_AUTO_FILL,
5961         ELM_MAP_ZOOM_MODE_LAST
5962      } Elm_Map_Zoom_Mode;
5963
5964    typedef enum _Elm_Map_Route_Sources
5965      {
5966         ELM_MAP_ROUTE_SOURCE_YOURS,
5967         ELM_MAP_ROUTE_SOURCE_MONAV,
5968         ELM_MAP_ROUTE_SOURCE_ORS,
5969         ELM_MAP_ROUTE_SOURCE_LAST
5970      } Elm_Map_Route_Sources;
5971
5972    typedef enum _Elm_Map_Name_Sources
5973      {
5974         ELM_MAP_NAME_SOURCE_NOMINATIM,
5975         ELM_MAP_NAME_SOURCE_LAST
5976      } Elm_Map_Name_Sources;
5977
5978    typedef enum _Elm_Map_Route_Type
5979      {
5980         ELM_MAP_ROUTE_TYPE_MOTOCAR,
5981         ELM_MAP_ROUTE_TYPE_BICYCLE,
5982         ELM_MAP_ROUTE_TYPE_FOOT,
5983         ELM_MAP_ROUTE_TYPE_LAST
5984      } Elm_Map_Route_Type;
5985
5986    typedef enum _Elm_Map_Route_Method
5987      {
5988         ELM_MAP_ROUTE_METHOD_FASTEST,
5989         ELM_MAP_ROUTE_METHOD_SHORTEST,
5990         ELM_MAP_ROUTE_METHOD_LAST
5991      } Elm_Map_Route_Method;
5992
5993    typedef enum _Elm_Map_Name_Method
5994      {
5995         ELM_MAP_NAME_METHOD_SEARCH,
5996         ELM_MAP_NAME_METHOD_REVERSE,
5997         ELM_MAP_NAME_METHOD_LAST
5998      } Elm_Map_Name_Method;
5999
6000    typedef struct _Elm_Map_Marker          Elm_Map_Marker;
6001    typedef struct _Elm_Map_Marker_Class    Elm_Map_Marker_Class;
6002    typedef struct _Elm_Map_Group_Class     Elm_Map_Group_Class;
6003    typedef struct _Elm_Map_Route           Elm_Map_Route;
6004    typedef struct _Elm_Map_Name            Elm_Map_Name;
6005    typedef struct _Elm_Map_Track           Elm_Map_Track;
6006
6007    typedef Evas_Object *(*ElmMapMarkerGetFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6008    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
6009    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6010    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data);
6011
6012    typedef char        *(*ElmMapModuleSourceFunc) (void);
6013    typedef int          (*ElmMapModuleZoomMinFunc) (void);
6014    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
6015    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
6016    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
6017    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
6018    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
6019    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
6020    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
6021
6022    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6023    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6024    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6025    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6026    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6027    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
6028    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6029    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6030    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6031    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6032    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6033    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6034    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
6035    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);
6036    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);
6037    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6038    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
6039    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);
6040    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);
6041    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
6042    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6043    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
6044    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6045    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6046    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
6047    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6048    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6049    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
6050    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6051    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6052    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6053    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
6054    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6055    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6056    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
6057    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6058    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6059    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6060    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
6061    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
6062    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6063    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
6064    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6065    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
6066    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6067    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6068    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6069    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6070    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6071    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
6072    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6073    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);
6074    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6075    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6076    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6077    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6078    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6079    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6080    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6081    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
6082    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6083    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
6084    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);
6085    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6086    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6087 #ifdef ELM_EMAP
6088    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
6089 #endif
6090    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
6091
6092    /* smart callbacks called:
6093     * "clicked" - when image clicked
6094     * "press" - when mouse/finger held down initially on image
6095     * "longpressed" - when mouse/finger held for long time on image
6096     * "clicked,double" - when mouse/finger double-clicked
6097     * "load,details" - when detailed image load begins
6098     * "loaded,details" - when detailed image load done
6099     * "zoom,start" - when zooming started
6100     * "zoom,stop" - when zooming stopped
6101     * "zoom,change" - when auto zoom mode changed zoom level
6102     * "scroll - the content has been scrolled (moved)
6103     * "scroll,anim,start" - scrolling animation has started
6104     * "scroll,anim,stop" - scrolling animation has stopped
6105     * "scroll,drag,start" - dragging the contents around has started
6106     * "scroll,drag,stop" - dragging the contents around has stopped
6107     */
6108
6109    /* Route */
6110    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
6111 #ifdef ELM_EMAP
6112    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
6113 #endif
6114    EAPI double elm_route_lon_min_get(Evas_Object *obj);
6115    EAPI double elm_route_lat_min_get(Evas_Object *obj);
6116    EAPI double elm_route_lon_max_get(Evas_Object *obj);
6117    EAPI double elm_route_lat_max_get(Evas_Object *obj);
6118
6119
6120    /* panel */
6121    typedef enum _Elm_Panel_Orient
6122      {
6123         ELM_PANEL_ORIENT_TOP,
6124         ELM_PANEL_ORIENT_BOTTOM,
6125         ELM_PANEL_ORIENT_LEFT,
6126         ELM_PANEL_ORIENT_RIGHT,
6127      } Elm_Panel_Orient;
6128
6129    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6130    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
6131    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6132    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6133    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6134    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6135    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
6136    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6137    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
6138
6139    /* panes */
6140    /**
6141     * TODO
6142     *
6143     * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
6144     * Add events (move, start ...)
6145     */
6146    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6147    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6148    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6149    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6150    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6151    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6152    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6153    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6154    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
6155    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6156    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6157    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
6158    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6159
6160    /* flip */
6161    typedef enum _Elm_Flip_Mode
6162      {
6163         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
6164         ELM_FLIP_ROTATE_X_CENTER_AXIS,
6165         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
6166         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
6167         ELM_FLIP_CUBE_LEFT,
6168         ELM_FLIP_CUBE_RIGHT,
6169         ELM_FLIP_CUBE_UP,
6170         ELM_FLIP_CUBE_DOWN,
6171         ELM_FLIP_PAGE_LEFT,
6172         ELM_FLIP_PAGE_RIGHT,
6173         ELM_FLIP_PAGE_UP,
6174         ELM_FLIP_PAGE_DOWN
6175      } Elm_Flip_Mode;
6176    typedef enum _Elm_Flip_Interaction
6177      {
6178         ELM_FLIP_INTERACTION_NONE,
6179         ELM_FLIP_INTERACTION_ROTATE,
6180         ELM_FLIP_INTERACTION_CUBE,
6181         ELM_FLIP_INTERACTION_PAGE
6182      } Elm_Flip_Interaction;
6183    typedef enum _Elm_Flip_Direction
6184      {
6185         ELM_FLIP_DIRECTION_UP,
6186         ELM_FLIP_DIRECTION_DOWN,
6187         ELM_FLIP_DIRECTION_LEFT,
6188         ELM_FLIP_DIRECTION_RIGHT
6189      } Elm_Flip_Direction;
6190
6191    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6192    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6193    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6194    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6195    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6196    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6197    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6198    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6199    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
6200    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
6201    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
6202    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
6203    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
6204    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
6205    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
6206    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
6207    /* smart callbacks called:
6208     * "animate,begin" - when a flip animation was started
6209     * "animate,done" - when a flip animation is finished
6210     */
6211
6212    /* scrolledentry */
6213    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6214    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
6215    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6216    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
6217    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6218    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6219    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6220    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6221    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6222    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6223    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6224    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6225    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6226    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6227    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
6228    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6229    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6230    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6231    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
6232    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
6233    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6234    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6235    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6236    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6237    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6238    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6239    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6240    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6241    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6242    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6243    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6244    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
6245    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
6246    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6247    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6248    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);
6249    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6250    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6251    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);
6252    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6253    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);
6254    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6255    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6256    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6257    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6258    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6259    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6260    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6261    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6262    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);
6263    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);
6264    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);
6265    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);
6266    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);
6267    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);
6268    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6269    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6270    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6271    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6272    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6273    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6274    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6275    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6276    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
6277    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
6278    EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
6279    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6280    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6281
6282    /* conformant */
6283    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6284    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6285    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6286    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6287    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6288
6289    /* mapbuf */
6290    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6291    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6292    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6293    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6294    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6295    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6296    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
6297    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6298    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
6299    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6300
6301    /**
6302     * @defgroup Flipselector Flip Selector
6303     *
6304     * A flip selector is a widget to show a set of @b text items, one
6305     * at a time, with the same sheet switching style as the @ref Clock
6306     * "clock" widget, when one changes the current displaying sheet
6307     * (thus, the "flip" in the name).
6308     *
6309     * User clicks to flip sheets which are @b held for some time will
6310     * make the flip selector to flip continuosly and automatically for
6311     * the user. The interval between flips will keep growing in time,
6312     * so that it helps the user to reach an item which is distant from
6313     * the current selection.
6314     *
6315     * Smart callbacks one can register to:
6316     * - @c "selected" - when the widget's selected text item is changed
6317     * - @c "overflowed" - when the widget's current selection is changed
6318     *   from the first item in its list to the last
6319     * - @c "underflowed" - when the widget's current selection is changed
6320     *   from the last item in its list to the first
6321     *
6322     * Available styles for it:
6323     * - @c "default"
6324     *
6325     * Here is an example on its usage:
6326     * @li @ref flipselector_example
6327     */
6328
6329    /**
6330     * @addtogroup Flipselector
6331     * @{
6332     */
6333
6334    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
6335
6336    /**
6337     * Add a new flip selector widget to the given parent Elementary
6338     * (container) widget
6339     *
6340     * @param parent The parent object
6341     * @return a new flip selector widget handle or @c NULL, on errors
6342     *
6343     * This function inserts a new flip selector widget on the canvas.
6344     *
6345     * @ingroup Flipselector
6346     */
6347    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6348
6349    /**
6350     * Programmatically select the next item of a flip selector widget
6351     *
6352     * @param obj The flipselector object
6353     *
6354     * @note The selection will be animated. Also, if it reaches the
6355     * end of its list of member items, it will continue with the first
6356     * one onwards.
6357     *
6358     * @ingroup Flipselector
6359     */
6360    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6361
6362    /**
6363     * Programmatically select the previous item of a flip selector
6364     * widget
6365     *
6366     * @param obj The flipselector object
6367     *
6368     * @note The selection will be animated.  Also, if it reaches the
6369     * beginning of its list of member items, it will continue with the
6370     * last one backwards.
6371     *
6372     * @ingroup Flipselector
6373     */
6374    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6375
6376    /**
6377     * Append a (text) item to a flip selector widget
6378     *
6379     * @param obj The flipselector object
6380     * @param label The (text) label of the new item
6381     * @param func Convenience callback function to take place when
6382     * item is selected
6383     * @param data Data passed to @p func, above
6384     * @return A handle to the item added or @c NULL, on errors
6385     *
6386     * The widget's list of labels to show will be appended with the
6387     * given value. If the user wishes so, a callback function pointer
6388     * can be passed, which will get called when this same item is
6389     * selected.
6390     *
6391     * @note The current selection @b won't be modified by appending an
6392     * element to the list.
6393     *
6394     * @note The maximum length of the text label is going to be
6395     * determined <b>by the widget's theme</b>. Strings larger than
6396     * that value are going to be @b truncated.
6397     *
6398     * @ingroup Flipselector
6399     */
6400    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6401
6402    /**
6403     * Prepend a (text) item to a flip selector widget
6404     *
6405     * @param obj The flipselector object
6406     * @param label The (text) label of the new item
6407     * @param func Convenience callback function to take place when
6408     * item is selected
6409     * @param data Data passed to @p func, above
6410     * @return A handle to the item added or @c NULL, on errors
6411     *
6412     * The widget's list of labels to show will be prepended with the
6413     * given value. If the user wishes so, a callback function pointer
6414     * can be passed, which will get called when this same item is
6415     * selected.
6416     *
6417     * @note The current selection @b won't be modified by prepending
6418     * an element to the list.
6419     *
6420     * @note The maximum length of the text label is going to be
6421     * determined <b>by the widget's theme</b>. Strings larger than
6422     * that value are going to be @b truncated.
6423     *
6424     * @ingroup Flipselector
6425     */
6426    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6427
6428    /**
6429     * Get the internal list of items in a given flip selector widget.
6430     *
6431     * @param obj The flipselector object
6432     * @return The list of items (#Elm_Flipselector_Item as data) or @c
6433     * NULL on errors.
6434     *
6435     * This list is @b not to be modified in any way and must not be
6436     * freed. Use the list members with functions like
6437     * elm_flipselector_item_label_set(),
6438     * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
6439     * elm_flipselector_item_del(),
6440     * elm_flipselector_item_selected_get(),
6441     * elm_flipselector_item_selected_set().
6442     *
6443     * @warning This list is only valid until @p obj object's internal
6444     * items list is changed. It should be fetched again with another
6445     * call to this function when changes happen.
6446     *
6447     * @ingroup Flipselector
6448     */
6449    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6450
6451    /**
6452     * Get the first item in the given flip selector widget's list of
6453     * items.
6454     *
6455     * @param obj The flipselector object
6456     * @return The first item or @c NULL, if it has no items (and on
6457     * errors)
6458     *
6459     * @see elm_flipselector_item_append()
6460     * @see elm_flipselector_last_item_get()
6461     *
6462     * @ingroup Flipselector
6463     */
6464    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6465
6466    /**
6467     * Get the last item in the given flip selector widget's list of
6468     * items.
6469     *
6470     * @param obj The flipselector object
6471     * @return The last item or @c NULL, if it has no items (and on
6472     * errors)
6473     *
6474     * @see elm_flipselector_item_prepend()
6475     * @see elm_flipselector_first_item_get()
6476     *
6477     * @ingroup Flipselector
6478     */
6479    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6480
6481    /**
6482     * Get the currently selected item in a flip selector widget.
6483     *
6484     * @param obj The flipselector object
6485     * @return The selected item or @c NULL, if the widget has no items
6486     * (and on erros)
6487     *
6488     * @ingroup Flipselector
6489     */
6490    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6491
6492    /**
6493     * Set whether a given flip selector widget's item should be the
6494     * currently selected one.
6495     *
6496     * @param item The flip selector item
6497     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
6498     *
6499     * This sets whether @p item is or not the selected (thus, under
6500     * display) one. If @p item is different than one under display,
6501     * the latter will be unselected. If the @p item is set to be
6502     * unselected, on the other hand, the @b first item in the widget's
6503     * internal members list will be the new selected one.
6504     *
6505     * @see elm_flipselector_item_selected_get()
6506     *
6507     * @ingroup Flipselector
6508     */
6509    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6510
6511    /**
6512     * Get whether a given flip selector widget's item is the currently
6513     * selected one.
6514     *
6515     * @param item The flip selector item
6516     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6517     * (or on errors).
6518     *
6519     * @see elm_flipselector_item_selected_set()
6520     *
6521     * @ingroup Flipselector
6522     */
6523    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6524
6525    /**
6526     * Delete a given item from a flip selector widget.
6527     *
6528     * @param item The item to delete
6529     *
6530     * @ingroup Flipselector
6531     */
6532    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6533
6534    /**
6535     * Get the label of a given flip selector widget's item.
6536     *
6537     * @param item The item to get label from
6538     * @return The text label of @p item or @c NULL, on errors
6539     *
6540     * @see elm_flipselector_item_label_set()
6541     *
6542     * @ingroup Flipselector
6543     */
6544    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6545
6546    /**
6547     * Set the label of a given flip selector widget's item.
6548     *
6549     * @param item The item to set label on
6550     * @param label The text label string, in UTF-8 encoding
6551     *
6552     * @see elm_flipselector_item_label_get()
6553     *
6554     * @ingroup Flipselector
6555     */
6556    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6557
6558    /**
6559     * Gets the item before @p item in a flip selector widget's
6560     * internal list of items.
6561     *
6562     * @param item The item to fetch previous from
6563     * @return The item before the @p item, in its parent's list. If
6564     *         there is no previous item for @p item or there's an
6565     *         error, @c NULL is returned.
6566     *
6567     * @see elm_flipselector_item_next_get()
6568     *
6569     * @ingroup Flipselector
6570     */
6571    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6572
6573    /**
6574     * Gets the item after @p item in a flip selector widget's
6575     * internal list of items.
6576     *
6577     * @param item The item to fetch next from
6578     * @return The item after the @p item, in its parent's list. If
6579     *         there is no next item for @p item or there's an
6580     *         error, @c NULL is returned.
6581     *
6582     * @see elm_flipselector_item_next_get()
6583     *
6584     * @ingroup Flipselector
6585     */
6586    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6587
6588    /**
6589     * Set the interval on time updates for an user mouse button hold
6590     * on a flip selector widget.
6591     *
6592     * @param obj The flip selector object
6593     * @param interval The (first) interval value in seconds
6594     *
6595     * This interval value is @b decreased while the user holds the
6596     * mouse pointer either flipping up or flipping doww a given flip
6597     * selector.
6598     *
6599     * This helps the user to get to a given item distant from the
6600     * current one easier/faster, as it will start to flip quicker and
6601     * quicker on mouse button holds.
6602     *
6603     * The calculation for the next flip interval value, starting from
6604     * the one set with this call, is the previous interval divided by
6605     * 1.05, so it decreases a little bit.
6606     *
6607     * The default starting interval value for automatic flips is
6608     * @b 0.85 seconds.
6609     *
6610     * @see elm_flipselector_interval_get()
6611     *
6612     * @ingroup Flipselector
6613     */
6614    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6615
6616    /**
6617     * Get the interval on time updates for an user mouse button hold
6618     * on a flip selector widget.
6619     *
6620     * @param obj The flip selector object
6621     * @return The (first) interval value, in seconds, set on it
6622     *
6623     * @see elm_flipselector_interval_set() for more details
6624     *
6625     * @ingroup Flipselector
6626     */
6627    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6628
6629    /**
6630     * @}
6631     */
6632
6633    /**
6634     * @addtogroup Animator Animator
6635     * @ingroup Elementary
6636     *
6637     * @brief Functions to ease creation of animations.
6638     *
6639     * elm_animator is designed to provide an easy way to create animations.
6640     * Creating an animation with elm_animator is as simple as setting a
6641     * duration, an operating callback and telling it to run the animation.
6642     * However that is not the full extent of elm_animator's ability, animations
6643     * can be paused and resumed, reversed and the animation need not be linear.
6644     *
6645     * To run an animation you must specify at least a duration and operation
6646     * callback, not setting any other properties will create a linear animation
6647     * that runs once and is not reversed.
6648     *
6649     * @ref elm_animator_example_page_01 "This" example should make all of that
6650     * very clear.
6651     *
6652     * @warning elm_animator is @b not a widget.
6653     * @{
6654     */
6655    /**
6656     * @brief Type of curve desired for animation.
6657     *
6658     * The speed in which an animation happens doesn't have to be linear, some
6659     * animations will look better if they're accelerating or decelerating, so
6660     * elm_animator provides four options in this regard:
6661     * @image html elm_animator_curve_style.png
6662     * @image latex elm_animator_curve_style.eps width=\textwidth
6663     * As can be seen in the image the speed of the animation will be:
6664     * @li ELM_ANIMATOR_CURVE_LINEAR constant
6665     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
6666     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
6667     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
6668     */
6669    typedef enum
6670      {
6671         ELM_ANIMATOR_CURVE_LINEAR,
6672         ELM_ANIMATOR_CURVE_IN_OUT,
6673         ELM_ANIMATOR_CURVE_IN,
6674         ELM_ANIMATOR_CURVE_OUT
6675      } Elm_Animator_Curve_Style;
6676    typedef struct _Elm_Animator Elm_Animator;
6677   /**
6678    * Called back per loop of an elementary animators cycle
6679    * @param data user-data given to elm_animator_operation_callback_set()
6680    * @param animator the animator being run
6681    * @param double the position in the animation
6682    */
6683    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
6684   /**
6685    * Called back when an elementary animator finishes
6686    * @param data user-data given to elm_animator_completion_callback_set()
6687    */
6688    typedef void (*Elm_Animator_Completion_Cb) (void *data);
6689
6690    /**
6691     * @brief Create a new animator.
6692     *
6693     * @param[in] parent Parent object
6694     *
6695     * The @a parent argument can be set to NULL for no parent. If a parent is set
6696     * there is no need to call elm_animator_del(), when the parent is deleted it
6697     * will delete the animator.
6698     * @deprecated Use @ref Transit instead.
6699
6700     */
6701    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
6702    /**
6703     * Deletes the animator freeing any resources it used. If the animator was
6704     * created with a NULL parent this must be called, otherwise it will be
6705     * automatically called when the parent is deleted.
6706     *
6707     * @param[in] animator Animator object
6708     * @deprecated Use @ref Transit instead.
6709     */
6710    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6711    /**
6712     * Set the duration of the animation.
6713     *
6714     * @param[in] animator Animator object
6715     * @param[in] duration Duration in second
6716     * @deprecated Use @ref Transit instead.
6717     */
6718    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
6719    /**
6720     * @brief Set the callback function for animator operation.
6721     *
6722     * @param[in] animator Animator object
6723     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
6724     * @param[in] data Callback function user argument
6725     *
6726     * The @p func callback will be called with a frame value in range [0, 1] which
6727     * indicates how far along the animation should be. It is the job of @p func to
6728     * actually change the state of any object(or objects) that are being animated.
6729     * @deprecated Use @ref Transit instead.
6730     */
6731    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
6732    /**
6733     * Set the callback function for the when the animation ends.
6734     *
6735     * @param[in]  animator Animator object
6736     * @param[in]  func   Callback function pointe
6737     * @param[in]  data Callback function user argument
6738     *
6739     * @warning @a func will not be executed if elm_animator_stop() is called.
6740     * @deprecated Use @ref Transit instead.
6741     */
6742    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
6743    /**
6744     * @brief Stop animator.
6745     *
6746     * @param[in] animator Animator object
6747     *
6748     * If called before elm_animator_animate() it does nothing. If there is an
6749     * animation in progress the animation will be stopped(the operation callback
6750     * will not be executed again) and it can't be restarted using
6751     * elm_animator_resume().
6752     * @deprecated Use @ref Transit instead.
6753     */
6754    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6755    /**
6756     * Set the animator repeat count.
6757     *
6758     * @param[in]  animator Animator object
6759     * @param[in]  repeat_cnt Repeat count
6760     * @deprecated Use @ref Transit instead.
6761     */
6762    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
6763    /**
6764     * @brief Start animation.
6765     *
6766     * @param[in] animator Animator object
6767     *
6768     * This function starts the animation if the nescessary properties(duration
6769     * and operation callback) have been set. Once started the animation will
6770     * run until complete or elm_animator_stop() is called.
6771     * @deprecated Use @ref Transit instead.
6772     */
6773    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6774    /**
6775     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6776     *
6777     * @param[in] animator Animator object
6778     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6779     * @deprecated Use @ref Transit instead.
6780     */
6781    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
6782    /**
6783     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
6784     *
6785     * @param[in] animator Animator object
6786     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
6787     * @deprecated Use @ref Transit instead.
6788     */
6789    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6790    /**
6791     * @brief Sets wether the animation should be automatically reversed.
6792     *
6793     * @param[in] animator Animator object
6794     * @param[in] reverse Reverse or not
6795     *
6796     * This controls wether the animation will be run on reverse imediately after
6797     * running forward. When this is set together with repetition the animation
6798     * will run in reverse once for each time it ran forward.@n
6799     * Runnin an animation in reverse is accomplished by calling the operation
6800     * callback with a frame value starting at 1 and diminshing until 0.
6801     * @deprecated Use @ref Transit instead.
6802     */
6803    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
6804    /**
6805     * Gets wether the animation will automatically reversed
6806     *
6807     * @param[in] animator Animator object
6808     * @deprecated Use @ref Transit instead.
6809     */
6810    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6811    /**
6812     * Gets the status for the animator operation. The status of the animator @b
6813     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
6814     * only informs if the animation was started and has not ended(either normally
6815     * or through elm_animator_stop()).
6816     *
6817     * @param[in] animator Animator object
6818     * @deprecated Use @ref Transit instead.
6819     */
6820    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6821    /**
6822     * Gets how many times the animation will be repeated
6823     *
6824     * @param[in] animator Animator object
6825     * @deprecated Use @ref Transit instead.
6826     */
6827    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
6828    /**
6829     * Pause the animator.
6830     *
6831     * @param[in]  animator Animator object
6832     *
6833     * This causes the animation to be temporarily stopped(the operation callback
6834     * will not be called). If the animation is not yet running this is a no-op.
6835     * Once an animation has been paused with this function it can be resumed
6836     * using elm_animator_resume().
6837     * @deprecated Use @ref Transit instead.
6838     */
6839    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6840    /**
6841     * @brief Resumes the animator.
6842     *
6843     * @param[in]  animator Animator object
6844     *
6845     * Resumes an animation that was paused using elm_animator_pause(), after
6846     * calling this function calls to the operation callback will happen
6847     * normally. If an animation is stopped by means of elm_animator_stop it
6848     * @b can't be restarted with this function.@n
6849     *
6850     * @warning When an animation is resumed it doesn't start from where it was paused, it
6851     * will go to where it would have been if it had not been paused. If an
6852     * animation with a duration of 3 seconds is paused after 1 second for 1 second
6853     * it will resume as if it had ben animating for 2 seconds, the operating
6854     * callback will be called with a frame value of aproximately 2/3.
6855     * @deprecated Use @ref Transit instead.
6856     */
6857    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
6858    /**
6859     * @}
6860     */
6861
6862    /* calendar */
6863    typedef enum
6864      {
6865         ELM_CALENDAR_UNIQUE,
6866         ELM_CALENDAR_DAILY,
6867         ELM_CALENDAR_WEEKLY,
6868         ELM_CALENDAR_MONTHLY,
6869         ELM_CALENDAR_ANNUALLY
6870      } Elm_Calendar_Mark_Repeat;
6871    typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
6872
6873    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6874    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6875    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
6876    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6877    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6878    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
6879    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
6880    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6881    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6882    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
6883    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
6884    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
6885    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);
6886    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
6887    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6888    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6889    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
6890    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6891    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6892    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6893    /* smart callbacks called:
6894     * changed - emitted when the user select a day or change the displayed
6895     * month.
6896     */
6897
6898    /* diskselector */
6899    typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
6900
6901    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6902    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6903    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
6904    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6905    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6906    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6907    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
6908    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6909    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6910    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);
6911    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6912    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6913    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6914    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);
6915    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6916    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6917    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6918    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6919    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
6920    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6921    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6922    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6923    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6924    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6925    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6926    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6927    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6928    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6929    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
6930    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);
6931    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6932    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6933    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6934    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6935    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6936    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6937    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
6938    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6939    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6940    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
6941    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
6942    /* smart callbacks called:
6943     * "selected" - when item is selected (scroller stops)
6944     */
6945
6946    /**
6947     * @page tutorial_colorselector Color selector example
6948     * @dontinclude colorselector_example_01.c
6949     *
6950     * This example shows how to change the color of a rectangle using a color
6951     * selector. We aren't going to explain a lot of the code since it's the
6952     * usual setup code:
6953     * @until show(rect)
6954     *
6955     * Now that we have a window with background and a rectangle we can create
6956     * our color_selector and set it's initial color to fully opaque blue:
6957     * @until show
6958     *
6959     * Next we tell ask to be notified whenever the color changes:
6960     * @until changed
6961     *
6962     * We follow that we some more run of the mill setup code:
6963     * @until ELM_MAIN()
6964     *
6965     * And now get to the callback that sets the color of the rectangle:
6966     * @until }
6967     *
6968     * This example will look like this:
6969     * @image html screenshots/colorselector_example_01.png
6970     * @image latex screenshots/colorselector_example_01.eps
6971     *
6972     * @example colorselector_example_01.c
6973     */
6974    /**
6975     * @defgroup Colorselector Colorselector
6976     *
6977     * @{
6978     *
6979     * @brief Widget for user to select a color.
6980     *
6981     * Signals that you can add callbacks for are:
6982     * "changed" - When the color value changes(event_info is NULL).
6983     *
6984     * See @ref tutorial_colorselector.
6985     */
6986    /**
6987     * @brief Add a new colorselector to the parent
6988     *
6989     * @param parent The parent object
6990     * @return The new object or NULL if it cannot be created
6991     *
6992     * @ingroup Colorselector
6993     */
6994    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6995    /**
6996     * Set a color for the colorselector
6997     *
6998     * @param obj   Colorselector object
6999     * @param r     r-value of color
7000     * @param g     g-value of color
7001     * @param b     b-value of color
7002     * @param a     a-value of color
7003     *
7004     * @ingroup Colorselector
7005     */
7006    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
7007    /**
7008     * Get a color from the colorselector
7009     *
7010     * @param obj   Colorselector object
7011     * @param r     integer pointer for r-value of color
7012     * @param g     integer pointer for g-value of color
7013     * @param b     integer pointer for b-value of color
7014     * @param a     integer pointer for a-value of color
7015     *
7016     * @ingroup Colorselector
7017     */
7018    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
7019    /**
7020     * @}
7021     */
7022
7023    /* Contextual Popup */
7024    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
7025
7026    typedef enum _Elm_Ctxpopup_Direction
7027      {
7028         ELM_CTXPOPUP_DIRECTION_DOWN,
7029         ELM_CTXPOPUP_DIRECTION_RIGHT,
7030         ELM_CTXPOPUP_DIRECTION_LEFT,
7031         ELM_CTXPOPUP_DIRECTION_UP,
7032      } Elm_Ctxpopup_Direction;
7033
7034    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7035    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7036    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7037    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7038    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
7039    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
7040    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7041    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7042    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7043    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7044    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);
7045    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7046    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7047    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7048    EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
7049    EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7050    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);
7051    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);
7052    /* smart callbacks called:
7053     * "dismissed" - the ctxpopup was dismissed
7054     */
7055
7056    /* transit */
7057    /**
7058     *
7059     * @defgroup Transit Transit
7060     * @ingroup Elementary
7061     *
7062     * Transit is designed to apply various animated transition effects to @c
7063     * Evas_Object, such like translation, rotation, etc. For using these
7064     * effects, create an @ref Elm_Transit and add the desired transition effects.
7065     *
7066     * Once the effects are added into transit, they will be automatically
7067     * managed (their callback will be called until the duration is ended, and
7068     * they will be deleted on completion).
7069     *
7070     * Example:
7071     * @code
7072     * Elm_Transit *trans = elm_transit_add();
7073     * elm_transit_object_add(trans, obj);
7074     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
7075     * elm_transit_duration_set(transit, 1);
7076     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
7077     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
7078     * elm_transit_repeat_times_set(transit, 3);
7079     * @endcode
7080     *
7081     * Some transition effects are used to change the properties of objects. They
7082     * are:
7083     * @li @ref elm_transit_effect_translation_add
7084     * @li @ref elm_transit_effect_color_add
7085     * @li @ref elm_transit_effect_rotation_add
7086     * @li @ref elm_transit_effect_wipe_add
7087     * @li @ref elm_transit_effect_zoom_add
7088     * @li @ref elm_transit_effect_resizing_add
7089     *
7090     * Other transition effects are used to make one object disappear and another
7091     * object appear on its old place. These effects are:
7092     *
7093     * @li @ref elm_transit_effect_flip_add
7094     * @li @ref elm_transit_effect_resizable_flip_add
7095     * @li @ref elm_transit_effect_fade_add
7096     * @li @ref elm_transit_effect_blend_add
7097     *
7098     * It's also possible to make a transition chain with @ref
7099     * elm_transit_chain_transit_add.
7100     *
7101     * @warning We strongly recommend to use elm_transit just when edje can not do
7102     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
7103     * animations can be manipulated inside the theme.
7104     *
7105     * List of examples:
7106     * @li @ref transit_example_01_explained
7107     * @li @ref transit_example_02_explained
7108     * @li @ref transit_example_03_c
7109     * @li @ref transit_example_04_c
7110     *
7111     * @{
7112     */
7113
7114    /**
7115     * @enum Elm_Transit_Tween_Mode
7116     *
7117     * The type of acceleration used in the transition.
7118     */
7119    typedef enum
7120      {
7121         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
7122         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
7123                                              over time, then decrease again
7124                                              and stop slowly */
7125         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
7126                                              speed over time */
7127         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
7128                                             over time */
7129      } Elm_Transit_Tween_Mode;
7130
7131    /**
7132     * @enum Elm_Transit_Effect_Flip_Axis
7133     *
7134     * The axis where flip effect should be applied.
7135     */
7136    typedef enum
7137      {
7138         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
7139         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
7140      } Elm_Transit_Effect_Flip_Axis;
7141    /**
7142     * @enum Elm_Transit_Effect_Wipe_Dir
7143     *
7144     * The direction where the wipe effect should occur.
7145     */
7146    typedef enum
7147      {
7148         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
7149         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
7150         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
7151         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
7152      } Elm_Transit_Effect_Wipe_Dir;
7153    /** @enum Elm_Transit_Effect_Wipe_Type
7154     *
7155     * Whether the wipe effect should show or hide the object.
7156     */
7157    typedef enum
7158      {
7159         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
7160                                              animation */
7161         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
7162                                             animation */
7163      } Elm_Transit_Effect_Wipe_Type;
7164
7165    /**
7166     * @typedef Elm_Transit
7167     *
7168     * The Transit created with elm_transit_add(). This type has the information
7169     * about the objects which the transition will be applied, and the
7170     * transition effects that will be used. It also contains info about
7171     * duration, number of repetitions, auto-reverse, etc.
7172     */
7173    typedef struct _Elm_Transit Elm_Transit;
7174    typedef void Elm_Transit_Effect;
7175    /**
7176     * @typedef Elm_Transit_Effect_Transition_Cb
7177     *
7178     * Transition callback called for this effect on each transition iteration.
7179     */
7180    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
7181    /**
7182     * Elm_Transit_Effect_End_Cb
7183     *
7184     * Transition callback called for this effect when the transition is over.
7185     */
7186    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
7187
7188    /**
7189     * Elm_Transit_Del_Cb
7190     *
7191     * A callback called when the transit is deleted.
7192     */
7193    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
7194
7195    /**
7196     * Add new transit.
7197     *
7198     * @note Is not necessary to delete the transit object, it will be deleted at
7199     * the end of its operation.
7200     * @note The transit will start playing when the program enter in the main loop, is not
7201     * necessary to give a start to the transit.
7202     *
7203     * @return The transit object.
7204     *
7205     * @ingroup Transit
7206     */
7207    EAPI Elm_Transit                *elm_transit_add(void);
7208
7209    /**
7210     * Stops the animation and delete the @p transit object.
7211     *
7212     * Call this function if you wants to stop the animation before the duration
7213     * time. Make sure the @p transit object is still alive with
7214     * elm_transit_del_cb_set() function.
7215     * All added effects will be deleted, calling its repective data_free_cb
7216     * functions. The function setted by elm_transit_del_cb_set() will be called.
7217     *
7218     * @see elm_transit_del_cb_set()
7219     *
7220     * @param transit The transit object to be deleted.
7221     *
7222     * @ingroup Transit
7223     * @warning Just call this function if you are sure the transit is alive.
7224     */
7225    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7226
7227    /**
7228     * Add a new effect to the transit.
7229     *
7230     * @note The cb function and the data are the key to the effect. If you try to
7231     * add an already added effect, nothing is done.
7232     * @note After the first addition of an effect in @p transit, if its
7233     * effect list become empty again, the @p transit will be killed by
7234     * elm_transit_del(transit) function.
7235     *
7236     * Exemple:
7237     * @code
7238     * Elm_Transit *transit = elm_transit_add();
7239     * elm_transit_effect_add(transit,
7240     *                        elm_transit_effect_blend_op,
7241     *                        elm_transit_effect_blend_context_new(),
7242     *                        elm_transit_effect_blend_context_free);
7243     * @endcode
7244     *
7245     * @param transit The transit object.
7246     * @param transition_cb The operation function. It is called when the
7247     * animation begins, it is the function that actually performs the animation.
7248     * It is called with the @p data, @p transit and the time progression of the
7249     * animation (a double value between 0.0 and 1.0).
7250     * @param effect The context data of the effect.
7251     * @param end_cb The function to free the context data, it will be called
7252     * at the end of the effect, it must finalize the animation and free the
7253     * @p data.
7254     *
7255     * @ingroup Transit
7256     * @warning The transit free the context data at the and of the transition with
7257     * the data_free_cb function, do not use the context data in another transit.
7258     */
7259    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);
7260
7261    /**
7262     * Delete an added effect.
7263     *
7264     * This function will remove the effect from the @p transit, calling the
7265     * data_free_cb to free the @p data.
7266     *
7267     * @see elm_transit_effect_add()
7268     *
7269     * @note If the effect is not found, nothing is done.
7270     * @note If the effect list become empty, this function will call
7271     * elm_transit_del(transit), that is, it will kill the @p transit.
7272     *
7273     * @param transit The transit object.
7274     * @param transition_cb The operation function.
7275     * @param effect The context data of the effect.
7276     *
7277     * @ingroup Transit
7278     */
7279    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);
7280
7281    /**
7282     * Add new object to apply the effects.
7283     *
7284     * @note After the first addition of an object in @p transit, if its
7285     * object list become empty again, the @p transit will be killed by
7286     * elm_transit_del(transit) function.
7287     * @note If the @p obj belongs to another transit, the @p obj will be
7288     * removed from it and it will only belong to the @p transit. If the old
7289     * transit stays without objects, it will die.
7290     * @note When you add an object into the @p transit, its state from
7291     * evas_object_pass_events_get(obj) is saved, and it is applied when the
7292     * transit ends, if you change this state whith evas_object_pass_events_set()
7293     * after add the object, this state will change again when @p transit stops to
7294     * run.
7295     *
7296     * @param transit The transit object.
7297     * @param obj Object to be animated.
7298     *
7299     * @ingroup Transit
7300     * @warning It is not allowed to add a new object after transit begins to go.
7301     */
7302    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7303
7304    /**
7305     * Removes an added object from the transit.
7306     *
7307     * @note If the @p obj is not in the @p transit, nothing is done.
7308     * @note If the list become empty, this function will call
7309     * elm_transit_del(transit), that is, it will kill the @p transit.
7310     *
7311     * @param transit The transit object.
7312     * @param obj Object to be removed from @p transit.
7313     *
7314     * @ingroup Transit
7315     * @warning It is not allowed to remove objects after transit begins to go.
7316     */
7317    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7318
7319    /**
7320     * Get the objects of the transit.
7321     *
7322     * @param transit The transit object.
7323     * @return a Eina_List with the objects from the transit.
7324     *
7325     * @ingroup Transit
7326     */
7327    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7328
7329    /**
7330     * Enable/disable keeping up the objects states.
7331     * If it is not kept, the objects states will be reset when transition ends.
7332     *
7333     * @note @p transit can not be NULL.
7334     * @note One state includes geometry, color, map data.
7335     *
7336     * @param transit The transit object.
7337     * @param state_keep Keeping or Non Keeping.
7338     *
7339     * @ingroup Transit
7340     */
7341    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
7342
7343    /**
7344     * Get a value whether the objects states will be reset or not.
7345     *
7346     * @note @p transit can not be NULL
7347     *
7348     * @see elm_transit_objects_final_state_keep_set()
7349     *
7350     * @param transit The transit object.
7351     * @return EINA_TRUE means the states of the objects will be reset.
7352     * If @p transit is NULL, EINA_FALSE is returned
7353     *
7354     * @ingroup Transit
7355     */
7356    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7357
7358    /**
7359     * Set the event enabled when transit is operating.
7360     *
7361     * If @p enabled is EINA_TRUE, the objects of the transit will receives
7362     * events from mouse and keyboard during the animation.
7363     * @note When you add an object with elm_transit_object_add(), its state from
7364     * evas_object_pass_events_get(obj) is saved, and it is applied when the
7365     * transit ends, if you change this state with evas_object_pass_events_set()
7366     * after adding the object, this state will change again when @p transit stops
7367     * to run.
7368     *
7369     * @param transit The transit object.
7370     * @param enabled Events are received when enabled is @c EINA_TRUE, and
7371     * ignored otherwise.
7372     *
7373     * @ingroup Transit
7374     */
7375    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7376
7377    /**
7378     * Get the value of event enabled status.
7379     *
7380     * @see elm_transit_event_enabled_set()
7381     *
7382     * @param transit The Transit object
7383     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
7384     * EINA_FALSE is returned
7385     *
7386     * @ingroup Transit
7387     */
7388    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7389
7390    /**
7391     * Set the user-callback function when the transit is deleted.
7392     *
7393     * @note Using this function twice will overwrite the first function setted.
7394     * @note the @p transit object will be deleted after call @p cb function.
7395     *
7396     * @param transit The transit object.
7397     * @param cb Callback function pointer. This function will be called before
7398     * the deletion of the transit.
7399     * @param data Callback funtion user data. It is the @p op parameter.
7400     *
7401     * @ingroup Transit
7402     */
7403    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
7404
7405    /**
7406     * Set reverse effect automatically.
7407     *
7408     * If auto reverse is setted, after running the effects with the progress
7409     * parameter from 0 to 1, it will call the effecs again with the progress
7410     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
7411     * where the duration was setted with the function elm_transit_add and
7412     * the repeat with the function elm_transit_repeat_times_set().
7413     *
7414     * @param transit The transit object.
7415     * @param reverse EINA_TRUE means the auto_reverse is on.
7416     *
7417     * @ingroup Transit
7418     */
7419    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7420
7421    /**
7422     * Get if the auto reverse is on.
7423     *
7424     * @see elm_transit_auto_reverse_set()
7425     *
7426     * @param transit The transit object.
7427     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
7428     * EINA_FALSE is returned
7429     *
7430     * @ingroup Transit
7431     */
7432    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7433
7434    /**
7435     * Set the transit repeat count. Effect will be repeated by repeat count.
7436     *
7437     * This function sets the number of repetition the transit will run after
7438     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
7439     * If the @p repeat is a negative number, it will repeat infinite times.
7440     *
7441     * @note If this function is called during the transit execution, the transit
7442     * will run @p repeat times, ignoring the times it already performed.
7443     *
7444     * @param transit The transit object
7445     * @param repeat Repeat count
7446     *
7447     * @ingroup Transit
7448     */
7449    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
7450
7451    /**
7452     * Get the transit repeat count.
7453     *
7454     * @see elm_transit_repeat_times_set()
7455     *
7456     * @param transit The Transit object.
7457     * @return The repeat count. If @p transit is NULL
7458     * 0 is returned
7459     *
7460     * @ingroup Transit
7461     */
7462    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7463
7464    /**
7465     * Set the transit animation acceleration type.
7466     *
7467     * This function sets the tween mode of the transit that can be:
7468     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
7469     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
7470     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
7471     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
7472     *
7473     * @param transit The transit object.
7474     * @param tween_mode The tween type.
7475     *
7476     * @ingroup Transit
7477     */
7478    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
7479
7480    /**
7481     * Get the transit animation acceleration type.
7482     *
7483     * @note @p transit can not be NULL
7484     *
7485     * @param transit The transit object.
7486     * @return The tween type. If @p transit is NULL
7487     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
7488     *
7489     * @ingroup Transit
7490     */
7491    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7492
7493    /**
7494     * Set the transit animation time
7495     *
7496     * @note @p transit can not be NULL
7497     *
7498     * @param transit The transit object.
7499     * @param duration The animation time.
7500     *
7501     * @ingroup Transit
7502     */
7503    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
7504
7505    /**
7506     * Get the transit animation time
7507     *
7508     * @note @p transit can not be NULL
7509     *
7510     * @param transit The transit object.
7511     *
7512     * @return The transit animation time.
7513     *
7514     * @ingroup Transit
7515     */
7516    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7517
7518    /**
7519     * Starts the transition.
7520     * Once this API is called, the transit begins to measure the time.
7521     *
7522     * @note @p transit can not be NULL
7523     *
7524     * @param transit The transit object.
7525     *
7526     * @ingroup Transit
7527     */
7528    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7529
7530    /**
7531     * Pause/Resume the transition.
7532     *
7533     * If you call elm_transit_go again, the transit will be started from the
7534     * beginning, and will be unpaused.
7535     *
7536     * @note @p transit can not be NULL
7537     *
7538     * @param transit The transit object.
7539     * @param paused Whether the transition should be paused or not.
7540     *
7541     * @ingroup Transit
7542     */
7543    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
7544
7545    /**
7546     * Get the value of paused status.
7547     *
7548     * @see elm_transit_paused_set()
7549     *
7550     * @note @p transit can not be NULL
7551     *
7552     * @param transit The transit object.
7553     * @return EINA_TRUE means transition is paused. If @p transit is NULL
7554     * EINA_FALSE is returned
7555     *
7556     * @ingroup Transit
7557     */
7558    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7559
7560    /**
7561     * Get the time progression of the animation (a double value between 0.0 and 1.0).
7562     *
7563     * The value returned is a fraction (current time / total time). It
7564     * represents the progression position relative to the total.
7565     *
7566     * @note @p transit can not be NULL
7567     *
7568     * @param transit The transit object.
7569     *
7570     * @return The time progression value. If @p transit is NULL
7571     * 0 is returned
7572     *
7573     * @ingroup Transit
7574     */
7575    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7576
7577    /**
7578     * Makes the chain relationship between two transits.
7579     *
7580     * @note @p transit can not be NULL. Transit would have multiple chain transits.
7581     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
7582     *
7583     * @param transit The transit object.
7584     * @param chain_transit The chain transit object. This transit will be operated
7585     *        after transit is done.
7586     *
7587     * This function adds @p chain_transit transition to a chain after the @p
7588     * transit, and will be started as soon as @p transit ends. See @ref
7589     * transit_example_02_explained for a full example.
7590     *
7591     * @ingroup Transit
7592     */
7593    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
7594
7595    /**
7596     * Cut off the chain relationship between two transits.
7597     *
7598     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
7599     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
7600     *
7601     * @param transit The transit object.
7602     * @param chain_transit The chain transit object.
7603     *
7604     * This function remove the @p chain_transit transition from the @p transit.
7605     *
7606     * @ingroup Transit
7607     */
7608    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
7609
7610    /**
7611     * Get the current chain transit list.
7612     *
7613     * @note @p transit can not be NULL.
7614     *
7615     * @param transit The transit object.
7616     * @return chain transit list.
7617     *
7618     * @ingroup Transit
7619     */
7620    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
7621
7622    /**
7623     * Add the Resizing Effect to Elm_Transit.
7624     *
7625     * @note This API is one of the facades. It creates resizing effect context
7626     * and add it's required APIs to elm_transit_effect_add.
7627     *
7628     * @see elm_transit_effect_add()
7629     *
7630     * @param transit Transit object.
7631     * @param from_w Object width size when effect begins.
7632     * @param from_h Object height size when effect begins.
7633     * @param to_w Object width size when effect ends.
7634     * @param to_h Object height size when effect ends.
7635     * @return Resizing effect context data.
7636     *
7637     * @ingroup Transit
7638     */
7639    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);
7640
7641    /**
7642     * Add the Translation Effect to Elm_Transit.
7643     *
7644     * @note This API is one of the facades. It creates translation effect context
7645     * and add it's required APIs to elm_transit_effect_add.
7646     *
7647     * @see elm_transit_effect_add()
7648     *
7649     * @param transit Transit object.
7650     * @param from_dx X Position variation when effect begins.
7651     * @param from_dy Y Position variation when effect begins.
7652     * @param to_dx X Position variation when effect ends.
7653     * @param to_dy Y Position variation when effect ends.
7654     * @return Translation effect context data.
7655     *
7656     * @ingroup Transit
7657     * @warning It is highly recommended just create a transit with this effect when
7658     * the window that the objects of the transit belongs has already been created.
7659     * This is because this effect needs the geometry information about the objects,
7660     * and if the window was not created yet, it can get a wrong information.
7661     */
7662    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);
7663
7664    /**
7665     * Add the Zoom Effect to Elm_Transit.
7666     *
7667     * @note This API is one of the facades. It creates zoom effect context
7668     * and add it's required APIs to elm_transit_effect_add.
7669     *
7670     * @see elm_transit_effect_add()
7671     *
7672     * @param transit Transit object.
7673     * @param from_rate Scale rate when effect begins (1 is current rate).
7674     * @param to_rate Scale rate when effect ends.
7675     * @return Zoom effect context data.
7676     *
7677     * @ingroup Transit
7678     * @warning It is highly recommended just create a transit with this effect when
7679     * the window that the objects of the transit belongs has already been created.
7680     * This is because this effect needs the geometry information about the objects,
7681     * and if the window was not created yet, it can get a wrong information.
7682     */
7683    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
7684
7685    /**
7686     * Add the Flip Effect to Elm_Transit.
7687     *
7688     * @note This API is one of the facades. It creates flip effect context
7689     * and add it's required APIs to elm_transit_effect_add.
7690     * @note This effect is applied to each pair of objects in the order they are listed
7691     * in the transit list of objects. The first object in the pair will be the
7692     * "front" object and the second will be the "back" object.
7693     *
7694     * @see elm_transit_effect_add()
7695     *
7696     * @param transit Transit object.
7697     * @param axis Flipping Axis(X or Y).
7698     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7699     * @return Flip effect context data.
7700     *
7701     * @ingroup Transit
7702     * @warning It is highly recommended just create a transit with this effect when
7703     * the window that the objects of the transit belongs has already been created.
7704     * This is because this effect needs the geometry information about the objects,
7705     * and if the window was not created yet, it can get a wrong information.
7706     */
7707    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7708
7709    /**
7710     * Add the Resizable Flip Effect to Elm_Transit.
7711     *
7712     * @note This API is one of the facades. It creates resizable flip effect context
7713     * and add it's required APIs to elm_transit_effect_add.
7714     * @note This effect is applied to each pair of objects in the order they are listed
7715     * in the transit list of objects. The first object in the pair will be the
7716     * "front" object and the second will be the "back" object.
7717     *
7718     * @see elm_transit_effect_add()
7719     *
7720     * @param transit Transit object.
7721     * @param axis Flipping Axis(X or Y).
7722     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
7723     * @return Resizable flip effect context data.
7724     *
7725     * @ingroup Transit
7726     * @warning It is highly recommended just create a transit with this effect when
7727     * the window that the objects of the transit belongs has already been created.
7728     * This is because this effect needs the geometry information about the objects,
7729     * and if the window was not created yet, it can get a wrong information.
7730     */
7731    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
7732
7733    /**
7734     * Add the Wipe Effect to Elm_Transit.
7735     *
7736     * @note This API is one of the facades. It creates wipe effect context
7737     * and add it's required APIs to elm_transit_effect_add.
7738     *
7739     * @see elm_transit_effect_add()
7740     *
7741     * @param transit Transit object.
7742     * @param type Wipe type. Hide or show.
7743     * @param dir Wipe Direction.
7744     * @return Wipe effect context data.
7745     *
7746     * @ingroup Transit
7747     * @warning It is highly recommended just create a transit with this effect when
7748     * the window that the objects of the transit belongs has already been created.
7749     * This is because this effect needs the geometry information about the objects,
7750     * and if the window was not created yet, it can get a wrong information.
7751     */
7752    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
7753
7754    /**
7755     * Add the Color Effect to Elm_Transit.
7756     *
7757     * @note This API is one of the facades. It creates color effect context
7758     * and add it's required APIs to elm_transit_effect_add.
7759     *
7760     * @see elm_transit_effect_add()
7761     *
7762     * @param transit        Transit object.
7763     * @param  from_r        RGB R when effect begins.
7764     * @param  from_g        RGB G when effect begins.
7765     * @param  from_b        RGB B when effect begins.
7766     * @param  from_a        RGB A when effect begins.
7767     * @param  to_r          RGB R when effect ends.
7768     * @param  to_g          RGB G when effect ends.
7769     * @param  to_b          RGB B when effect ends.
7770     * @param  to_a          RGB A when effect ends.
7771     * @return               Color effect context data.
7772     *
7773     * @ingroup Transit
7774     */
7775    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);
7776
7777    /**
7778     * Add the Fade Effect to Elm_Transit.
7779     *
7780     * @note This API is one of the facades. It creates fade effect context
7781     * and add it's required APIs to elm_transit_effect_add.
7782     * @note This effect is applied to each pair of objects in the order they are listed
7783     * in the transit list of objects. The first object in the pair will be the
7784     * "before" object and the second will be the "after" object.
7785     *
7786     * @see elm_transit_effect_add()
7787     *
7788     * @param transit Transit object.
7789     * @return Fade effect context data.
7790     *
7791     * @ingroup Transit
7792     * @warning It is highly recommended just create a transit with this effect when
7793     * the window that the objects of the transit belongs has already been created.
7794     * This is because this effect needs the color information about the objects,
7795     * and if the window was not created yet, it can get a wrong information.
7796     */
7797    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
7798
7799    /**
7800     * Add the Blend Effect to Elm_Transit.
7801     *
7802     * @note This API is one of the facades. It creates blend effect context
7803     * and add it's required APIs to elm_transit_effect_add.
7804     * @note This effect is applied to each pair of objects in the order they are listed
7805     * in the transit list of objects. The first object in the pair will be the
7806     * "before" object and the second will be the "after" object.
7807     *
7808     * @see elm_transit_effect_add()
7809     *
7810     * @param transit Transit object.
7811     * @return Blend effect context data.
7812     *
7813     * @ingroup Transit
7814     * @warning It is highly recommended just create a transit with this effect when
7815     * the window that the objects of the transit belongs has already been created.
7816     * This is because this effect needs the color information about the objects,
7817     * and if the window was not created yet, it can get a wrong information.
7818     */
7819    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
7820
7821    /**
7822     * Add the Rotation Effect to Elm_Transit.
7823     *
7824     * @note This API is one of the facades. It creates rotation effect context
7825     * and add it's required APIs to elm_transit_effect_add.
7826     *
7827     * @see elm_transit_effect_add()
7828     *
7829     * @param transit Transit object.
7830     * @param from_degree Degree when effect begins.
7831     * @param to_degree Degree when effect is ends.
7832     * @return Rotation effect context data.
7833     *
7834     * @ingroup Transit
7835     * @warning It is highly recommended just create a transit with this effect when
7836     * the window that the objects of the transit belongs has already been created.
7837     * This is because this effect needs the geometry information about the objects,
7838     * and if the window was not created yet, it can get a wrong information.
7839     */
7840    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
7841
7842    /**
7843     * Add the ImageAnimation Effect to Elm_Transit.
7844     *
7845     * @note This API is one of the facades. It creates image animation effect context
7846     * and add it's required APIs to elm_transit_effect_add.
7847     * The @p images parameter is a list images paths. This list and
7848     * its contents will be deleted at the end of the effect by
7849     * elm_transit_effect_image_animation_context_free() function.
7850     *
7851     * Example:
7852     * @code
7853     * char buf[PATH_MAX];
7854     * Eina_List *images = NULL;
7855     * Elm_Transit *transi = elm_transit_add();
7856     *
7857     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
7858     * images = eina_list_append(images, eina_stringshare_add(buf));
7859     *
7860     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
7861     * images = eina_list_append(images, eina_stringshare_add(buf));
7862     * elm_transit_effect_image_animation_add(transi, images);
7863     *
7864     * @endcode
7865     *
7866     * @see elm_transit_effect_add()
7867     *
7868     * @param transit Transit object.
7869     * @param images Eina_List of images file paths. This list and
7870     * its contents will be deleted at the end of the effect by
7871     * elm_transit_effect_image_animation_context_free() function.
7872     * @return Image Animation effect context data.
7873     *
7874     * @ingroup Transit
7875     */
7876    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
7877    /**
7878     * @}
7879     */
7880
7881    /* Store */
7882    typedef struct _Elm_Store                      Elm_Store;
7883    typedef struct _Elm_Store_DBsystem             Elm_Store_DBsystem;
7884    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
7885    typedef struct _Elm_Store_Item                 Elm_Store_Item;
7886    typedef struct _Elm_Store_Item_DBsystem        Elm_Store_Item_DBsystem;
7887    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
7888    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
7889    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
7890    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
7891    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
7892    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
7893    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
7894    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
7895
7896    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
7897    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7898    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
7899    typedef void      (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
7900    typedef int       (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
7901    typedef void      (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
7902    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
7903
7904    typedef enum
7905      {
7906         ELM_STORE_ITEM_MAPPING_NONE = 0,
7907         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
7908         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
7909         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
7910         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
7911         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
7912         // can add more here as needed by common apps
7913         ELM_STORE_ITEM_MAPPING_LAST
7914      } Elm_Store_Item_Mapping_Type;
7915
7916    struct _Elm_Store_Item_Mapping_Icon
7917      {
7918         // FIXME: allow edje file icons
7919         int                   w, h;
7920         Elm_Icon_Lookup_Order lookup_order;
7921         Eina_Bool             standard_name : 1;
7922         Eina_Bool             no_scale : 1;
7923         Eina_Bool             smooth : 1;
7924         Eina_Bool             scale_up : 1;
7925         Eina_Bool             scale_down : 1;
7926      };
7927
7928    struct _Elm_Store_Item_Mapping_Empty
7929      {
7930         Eina_Bool             dummy;
7931      };
7932
7933    struct _Elm_Store_Item_Mapping_Photo
7934      {
7935         int                   size;
7936      };
7937
7938    struct _Elm_Store_Item_Mapping_Custom
7939      {
7940         Elm_Store_Item_Mapping_Cb func;
7941      };
7942
7943    struct _Elm_Store_Item_Mapping
7944      {
7945         Elm_Store_Item_Mapping_Type     type;
7946         const char                     *part;
7947         int                             offset;
7948         union {
7949              Elm_Store_Item_Mapping_Empty  empty;
7950              Elm_Store_Item_Mapping_Icon   icon;
7951              Elm_Store_Item_Mapping_Photo  photo;
7952              Elm_Store_Item_Mapping_Custom custom;
7953              // add more types here
7954         } details;
7955      };
7956
7957    struct _Elm_Store_Item_Info
7958      {
7959         int                           index;
7960         int                           item_type;
7961         int                           group_index;
7962         Eina_Bool                     rec_item;
7963         int                           pre_group_index;
7964
7965         Elm_Genlist_Item_Class       *item_class;
7966         const Elm_Store_Item_Mapping *mapping;
7967         void                         *data;
7968         char                         *sort_id;
7969      };
7970
7971    struct _Elm_Store_Item_Info_Filesystem
7972      {
7973         Elm_Store_Item_Info  base;
7974         char                *path;
7975      };
7976
7977 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
7978 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
7979
7980    EAPI Elm_Store              *elm_store_dbsystem_new(void);
7981    EAPI void                    elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
7982    EAPI void                    elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
7983    EAPI void                    elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
7984    EAPI void                    elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
7985    EAPI int                     elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7986    EAPI void                   *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7987    EAPI void                    elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
7988    EAPI int                     elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7989    EAPI Elm_Store_Item         *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
7990    EAPI void                    elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7991    EAPI void                    elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
7992    EAPI void                    elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7993    EAPI void                    elm_store_free(Elm_Store *st);
7994    EAPI Elm_Store              *elm_store_filesystem_new(void);
7995    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
7996    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
7997    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
7998    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
7999    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
8000    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8001    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8002    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8003    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
8004    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8005    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8006    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
8007    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8008    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
8009    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8010    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8011    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8012
8013    /* SegmentControl */
8014    typedef struct _Elm_Segment_Item Elm_Segment_Item;
8015    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8016    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
8017    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);
8018    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8019    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8020    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8021    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8022    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8023    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
8024    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8025    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
8026    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8027    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8028    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8029    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
8030    /* smart callbacks called:
8031     * "changed" -when the user clicks on a segment item which is not previously
8032     *            selected and get selected. The event_info parameter is the
8033     *            segment item index.
8034     */
8035
8036    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
8037    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
8038    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
8039    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
8040    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
8041    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
8042    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
8043    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
8044
8045    EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
8046    EAPI void         elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
8047
8048    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
8049    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
8050    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
8051    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
8052    EAPI void elm_video_play(Evas_Object *video);
8053    EAPI void elm_video_pause(Evas_Object *video);
8054    EAPI void elm_video_stop(Evas_Object *video);
8055    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
8056    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
8057    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
8058    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
8059    EAPI double elm_video_audio_level_get(Evas_Object *video);
8060    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
8061    EAPI double elm_video_play_position_get(Evas_Object *video);
8062    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
8063    EAPI double elm_video_play_length_get(Evas_Object *video);
8064    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
8065    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
8066    EAPI const char *elm_video_title_get(Evas_Object *video);
8067
8068    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
8069    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
8070
8071    // FIXME: incomplete - carousel. don't use this until this comment is removed
8072    typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
8073    EAPI Evas_Object       *elm_carousel_add(Evas_Object *parent);
8074    EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
8075    EAPI void               elm_carousel_item_del(Elm_Carousel_Item *item);
8076    EAPI void               elm_carousel_item_select(Elm_Carousel_Item *item);
8077    /* smart callbacks called:
8078     * "clicked" - when the user clicks on a carousel item and becomes selected
8079     */
8080
8081    /* datefield */
8082    typedef enum _Elm_Datefield_Layout
8083      {
8084         ELM_DATEFIELD_LAYOUT_TIME,
8085         ELM_DATEFIELD_LAYOUT_DATE,
8086         ELM_DATEFIELD_LAYOUT_DATEANDTIME
8087      } Elm_Datefield_Layout;
8088
8089    EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
8090    EAPI void         elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
8091    EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
8092    EAPI void         elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
8093    EAPI void         elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
8094    EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
8095    EAPI void         elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
8096    EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
8097    EAPI void         elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
8098    EAPI void         elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
8099    EAPI Eina_Bool    elm_datefield_time_mode_get(const Evas_Object *obj);
8100    EAPI void         elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
8101    EAPI const char  *elm_datefield_date_format_get(const Evas_Object *obj);
8102    EAPI void         elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
8103    EAPI void         elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
8104    /* smart callbacks called:
8105    * "changed" - when datefield entry is changed, this signal is sent.
8106    */
8107
8108    /* popup */
8109    typedef enum _Elm_Popup_Response
8110      {
8111         ELM_POPUP_RESPONSE_NONE = -1,
8112         ELM_POPUP_RESPONSE_TIMEOUT = -2,
8113         ELM_POPUP_RESPONSE_OK = -3,
8114         ELM_POPUP_RESPONSE_CANCEL = -4,
8115         ELM_POPUP_RESPONSE_CLOSE = -5
8116      } Elm_Popup_Response;
8117
8118    typedef enum _Elm_Popup_Mode
8119      {
8120         ELM_POPUP_TYPE_NONE = 0,
8121         ELM_POPUP_TYPE_ALERT = (1 << 0)
8122      } Elm_Popup_Mode;
8123
8124    typedef enum _Elm_Popup_Orient
8125      {
8126         ELM_POPUP_ORIENT_TOP,
8127         ELM_POPUP_ORIENT_CENTER,
8128         ELM_POPUP_ORIENT_BOTTOM,
8129         ELM_POPUP_ORIENT_LEFT,
8130         ELM_POPUP_ORIENT_RIGHT,
8131         ELM_POPUP_ORIENT_TOP_LEFT,
8132         ELM_POPUP_ORIENT_TOP_RIGHT,
8133         ELM_POPUP_ORIENT_BOTTOM_LEFT,
8134         ELM_POPUP_ORIENT_BOTTOM_RIGHT
8135      } Elm_Popup_Orient;
8136
8137    /* smart callbacks called:
8138     * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
8139     */
8140
8141    EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
8142    EAPI void         elm_popup_desc_set(Evas_Object *obj, const char *text);
8143    EAPI const char  *elm_popup_desc_get(Evas_Object *obj);
8144    EAPI void         elm_popup_title_label_set(Evas_Object *obj, const char *text);
8145    EAPI const char  *elm_popup_title_label_get(Evas_Object *obj);
8146    EAPI void         elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
8147    EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
8148    EAPI void         elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
8149    EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
8150    EAPI void         elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text,  ...);
8151    EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
8152    EAPI void         elm_popup_timeout_set(Evas_Object *obj, double timeout);
8153    EAPI void         elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
8154    EAPI void         elm_popup_response(Evas_Object *obj, int  response_id);
8155    EAPI void         elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
8156    EAPI int          elm_popup_run(Evas_Object *obj);
8157
8158    /* NavigationBar */
8159    #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8160    #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8161
8162    typedef enum
8163      {
8164         ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
8165         ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
8166         ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
8167         ELM_NAVIGATIONBAR_BACK_BUTTON
8168      } Elm_Navi_Button_Type;
8169
8170    EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
8171    EAPI void         elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
8172    EAPI void         elm_navigationbar_pop(Evas_Object *obj);
8173    EAPI void         elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
8174    EAPI void         elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
8175    EAPI const char  *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
8176    EAPI void         elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
8177    EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
8178    EAPI Eina_List   *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
8179    EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
8180    EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
8181    EAPI void         elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
8182    EAPI void         elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
8183    EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
8184    EAPI const char  *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
8185    EAPI void         elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
8186    EAPI void         elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
8187    EAPI void         elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
8188    EAPI void         elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
8189    Eina_Bool         elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
8190    EAPI void         elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
8191    EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
8192
8193    /* NavigationBar */
8194    #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8195    #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8196
8197    typedef enum
8198      {
8199         ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
8200         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
8201         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
8202         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
8203         ELM_NAVIGATIONBAR_EX_MAX
8204      } Elm_Navi_ex_Button_Type;
8205    typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
8206
8207    EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
8208    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
8209    EAPI void         elm_navigationbar_ex_item_pop(Evas_Object *obj);
8210    EAPI void         elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
8211    EAPI void         elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
8212    EAPI void         elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
8213    EAPI const char  *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
8214    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
8215    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
8216    EAPI void         elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
8217    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
8218    EAPI void         elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
8219    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
8220    EAPI void         elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
8221    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
8222    EAPI const char  *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
8223    EAPI void         elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
8224    EAPI void         elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
8225    EAPI const char  *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
8226    EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
8227    EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
8228    EAPI void         elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
8229    EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
8230    EAPI void         elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
8231    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
8232    EAPI void         elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
8233    EAPI void         elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
8234    Eina_Bool         elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
8235
8236   /* naviframe */
8237   #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
8238   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
8239   #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
8240   #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
8241
8242    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8243    EAPI Elm_Object_Item    *elm_naviframe_item_push(Evas_Object *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
8244    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
8245    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
8246    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8247    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8248    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8249    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
8250    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8251    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
8252    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8253
8254    /* Control Bar */
8255    #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
8256    #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
8257    #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
8258    #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
8259    #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
8260    #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
8261    #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
8262    #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
8263    #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
8264
8265    typedef enum _Elm_Controlbar_Mode_Type
8266      {
8267         ELM_CONTROLBAR_MODE_DEFAULT = 0,
8268         ELM_CONTROLBAR_MODE_TRANSLUCENCE,
8269         ELM_CONTROLBAR_MODE_TRANSPARENCY,
8270         ELM_CONTROLBAR_MODE_LARGE,
8271         ELM_CONTROLBAR_MODE_SMALL,
8272         ELM_CONTROLBAR_MODE_LEFT,
8273         ELM_CONTROLBAR_MODE_RIGHT
8274      } Elm_Controlbar_Mode_Type;
8275
8276    typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
8277    EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
8278    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8279    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8280    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
8281    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
8282    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8283    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8284    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8285    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
8286    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8287    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8288    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
8289    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
8290    EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
8291    EAPI void         elm_controlbar_item_del(Elm_Controlbar_Item *it);
8292    EAPI void         elm_controlbar_item_select(Elm_Controlbar_Item *it);
8293    EAPI void         elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
8294    EAPI Eina_Bool    elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
8295    EAPI void         elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
8296    EAPI Eina_Bool    elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
8297    EAPI void         elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
8298    EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
8299    EAPI void         elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
8300    EAPI const char  *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
8301    EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
8302    EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
8303    EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
8304    EAPI const Eina_List   *elm_controlbar_items_get(const Evas_Object *obj);
8305    EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
8306    EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
8307    EAPI void         elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
8308    EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
8309    EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
8310    EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
8311    EAPI void         elm_controlbar_mode_set(Evas_Object *obj, int mode);
8312    EAPI void         elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
8313    EAPI void         elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
8314    EAPI void         elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
8315
8316    /* SearchBar */
8317    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
8318    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
8319    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
8320    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
8321    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
8322    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
8323    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
8324    EAPI void         elm_searchbar_clear(Evas_Object *obj);
8325    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
8326
8327    EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
8328    EAPI void         elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
8329    EAPI void         elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
8330    EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
8331
8332    /* NoContents */
8333    EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
8334    EAPI void         elm_nocontents_label_set(Evas_Object *obj, const char *label);
8335    EAPI const char  *elm_nocontents_label_get(const Evas_Object *obj);
8336    EAPI void         elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
8337    EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
8338
8339 /* TickerNoti */
8340 typedef enum
8341   {
8342      ELM_TICKERNOTI_DEFAULT,
8343      ELM_TICKERNOTI_DETAILVIEW
8344   } Elm_Tickernoti_Mode;
8345
8346 typedef enum
8347   {
8348      ELM_TICKERNOTI_ORIENT_TOP,
8349      ELM_TICKERNOTI_ORIENT_BOTTOM
8350   } Elm_Tickernoti_Orient;
8351
8352    EAPI Evas_Object              *elm_tickernoti_add (Evas_Object *parent);
8353    EAPI void                      elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8354    EAPI Evas_Object              *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8355    EAPI void                      elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8356    EAPI const char               *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8357    EAPI void                      elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
8358    EAPI Evas_Object              *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8359    EAPI void                      elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
8360    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8361    EAPI int                       elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8362    EAPI void                      elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
8363    /* #### Below APIs are going to be deprecated, announcment will be made soon ####*/
8364    EAPI Evas_Object              *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8365    EAPI void                      elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8366    EAPI const char               *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
8367    EAPI void                      elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
8368    EAPI Evas_Object              *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8369    EAPI void                      elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8370    EAPI Evas_Object              *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8371    EAPI Evas_Object              *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8372    EAPI void                      elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
8373    EAPI Elm_Tickernoti_Mode       elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8374    /* ############################################################################### */
8375    /* smart callbacks called:
8376     * @li "clicked" - emitted when tickernoti is clicked, except at the
8377     * swallow/button region, if any.
8378     * @li "hide" - emitted when the tickernoti is completelyhidden. In case of
8379     * any hide animation, this signal is raised after the animation.
8380     */
8381
8382    /* colorpalette */
8383    typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
8384
8385    struct _Colorpalette_Color
8386      {
8387         unsigned int r, g, b;
8388      };
8389
8390    EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
8391    EAPI void         elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
8392    EAPI void         elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
8393    /* smart callbacks called:
8394     * "clicked" - when image clicked
8395     */
8396
8397    /* editfield */
8398    EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
8399    EAPI void         elm_editfield_label_set(Evas_Object *obj, const char *label);
8400    EAPI const char  *elm_editfield_label_get(Evas_Object *obj);
8401    EAPI void         elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
8402    EAPI const char  *elm_editfield_guide_text_get(Evas_Object *obj);
8403    EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
8404 //   EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
8405    EAPI void         elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
8406    EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
8407    EAPI void         elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
8408    EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
8409    EAPI void         elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
8410    EAPI Eina_Bool    elm_editfield_entry_single_line_get(Evas_Object *obj);
8411    EAPI void         elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
8412    EAPI Eina_Bool    elm_editfield_eraser_get(Evas_Object *obj);
8413    /* smart callbacks called:
8414     * "clicked" - when an editfield is clicked
8415     * "unfocused" - when an editfield is unfocused
8416     */
8417
8418
8419    /* Sliding Drawer */
8420    typedef enum _Elm_SlidingDrawer_Pos
8421      {
8422         ELM_SLIDINGDRAWER_BOTTOM,
8423         ELM_SLIDINGDRAWER_LEFT,
8424         ELM_SLIDINGDRAWER_RIGHT,
8425         ELM_SLIDINGDRAWER_TOP
8426      } Elm_SlidingDrawer_Pos;
8427
8428    typedef struct _Elm_SlidingDrawer_Drag_Value
8429      {
8430         double x, y;
8431      } Elm_SlidingDrawer_Drag_Value;
8432
8433    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
8434    EINA_DEPRECATED EAPI void         elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
8435    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
8436    EINA_DEPRECATED EAPI void         elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
8437    EINA_DEPRECATED EAPI void         elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw,  double dh);
8438    EINA_DEPRECATED EAPI void         elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
8439
8440    /* multibuttonentry */
8441    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
8442    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
8443    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent);
8444    EAPI const char                *elm_multibuttonentry_label_get(Evas_Object *obj);
8445    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
8446    EAPI Evas_Object               *elm_multibuttonentry_entry_get(Evas_Object *obj);
8447    EAPI const char *               elm_multibuttonentry_guide_text_get(Evas_Object *obj);
8448    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
8449    EAPI int                        elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
8450    EAPI void                       elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
8451    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
8452    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
8453    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
8454    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
8455    EAPI const Eina_List           *elm_multibuttonentry_items_get(Evas_Object *obj);
8456    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
8457    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
8458    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
8459    EAPI void                       elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
8460    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
8461    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
8462    EAPI void                       elm_multibuttonentry_items_del(Evas_Object *obj);
8463    EAPI const char                *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
8464    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
8465    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
8466    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
8467    EAPI void                      *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
8468    EAPI void                       elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
8469    EAPI void                       elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
8470    /* smart callback called:
8471     * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
8472     * "added" - This signal is emitted when a new multibuttonentry item is added.
8473     * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
8474     * "expanded" - This signal is emitted when a multibuttonentry is expanded.
8475     * "contracted" - This signal is emitted when a multibuttonentry is contracted.
8476     * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
8477     * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
8478     * "item,added" - This signal is emitted when a new multibuttonentry item is added.
8479     * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
8480     * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
8481     * "clicked" - This signal is emitted when a multibuttonentry is clicked.
8482     * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
8483     */
8484    /* available styles:
8485     * default
8486     */
8487
8488    /* stackedicon */
8489    typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
8490    EAPI Evas_Object          *elm_stackedicon_add(Evas_Object *parent);
8491    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
8492    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
8493    EAPI void                  elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
8494    EAPI Eina_List            *elm_stackedicon_item_list_get(Evas_Object *obj);
8495    /* smart callback called:
8496     * "expanded" - This signal is emitted when a stackedicon is expanded.
8497     * "clicked" - This signal is emitted when a stackedicon is clicked.
8498     */
8499    /* available styles:
8500     * default
8501     */
8502
8503    /* dialoguegroup */
8504    typedef struct _Dialogue_Item Dialogue_Item;
8505
8506    typedef enum _Elm_Dialoguegourp_Item_Style
8507      {
8508         ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
8509         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
8510         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
8511         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
8512         ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
8513         ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
8514         ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
8515         ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
8516         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
8517         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
8518         ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
8519      } Elm_Dialoguegroup_Item_Style;
8520
8521    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_add(Evas_Object *parent);
8522    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
8523    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
8524    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
8525    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
8526    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove(Dialogue_Item *item);
8527    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove_all(Evas_Object *obj);
8528    EINA_DEPRECATED EAPI void           elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
8529    EINA_DEPRECATED EAPI const char    *elm_dialoguegroup_title_get(Evas_Object *obj);
8530    EINA_DEPRECATED EAPI void           elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
8531    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
8532    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
8533    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
8534    EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style    elm_dialoguegroup_item_style_get(Dialogue_Item *item);
8535    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
8536    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
8537
8538    /* Dayselector */
8539    typedef enum
8540      {
8541         ELM_DAYSELECTOR_SUN,
8542         ELM_DAYSELECTOR_MON,
8543         ELM_DAYSELECTOR_TUE,
8544         ELM_DAYSELECTOR_WED,
8545         ELM_DAYSELECTOR_THU,
8546         ELM_DAYSELECTOR_FRI,
8547         ELM_DAYSELECTOR_SAT
8548      } Elm_DaySelector_Day;
8549
8550    EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
8551    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
8552    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
8553
8554    /* Image Slider */
8555    typedef struct _Imageslider_Item Elm_Imageslider_Item;
8556    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
8557    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8558    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
8559    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
8560    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
8561    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8562    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8563    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8564    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8565    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8566    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8567    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8568    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8569    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8570    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
8571    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
8572 #ifdef __cplusplus
8573 }
8574 #endif
8575
8576 #endif