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