Expand docs for elm_box
[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.dox
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     * @}
681     */
682
683    EAPI void         elm_all_flush(void);
684    EAPI int          elm_cache_flush_interval_get(void);
685    EAPI void         elm_cache_flush_interval_set(int size);
686    EAPI void         elm_cache_flush_interval_all_set(int size);
687    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
688    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
689    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
690    EAPI int          elm_font_cache_get(void);
691    EAPI void         elm_font_cache_set(int size);
692    EAPI void         elm_font_cache_all_set(int size);
693    EAPI int          elm_image_cache_get(void);
694    EAPI void         elm_image_cache_set(int size);
695    EAPI void         elm_image_cache_all_set(int size);
696    EAPI int          elm_edje_file_cache_get(void);
697    EAPI void         elm_edje_file_cache_set(int size);
698    EAPI void         elm_edje_file_cache_all_set(int size);
699    EAPI int          elm_edje_collection_cache_get(void);
700    EAPI void         elm_edje_collection_cache_set(int size);
701    EAPI void         elm_edje_collection_cache_all_set(int size);
702
703    /**
704     * @defgroup Scaling Selective Widget Scaling
705     *
706     * Different widgets can be scaled independently. These functions
707     * allow you to manipulate this scaling on a per-widget basis. The
708     * object and all its children get their scaling factors multiplied
709     * by the scale factor set. This is multiplicative, in that if a
710     * child also has a scale size set it is in turn multiplied by its
711     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
712     * double size, @c 0.5 is half, etc.
713     *
714     * @ref general_functions_example_page "This" example contemplates
715     * some of these functions.
716     */
717
718    /**
719     * Set the scaling factor for a given Elementary object
720     *
721     * @param obj The Elementary to operate on
722     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
723     * no scaling)
724     *
725     * @ingroup Scaling
726     */
727    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
728
729    /**
730     * Get the scaling factor for a given Elementary object
731     *
732     * @param obj The object
733     * @return The scaling factor set by elm_object_scale_set()
734     *
735     * @ingroup Scaling
736     */
737    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
738    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
739    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
740    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
741    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
742    /**
743     * Set the style to use by a widget
744     *
745     * Sets the style name that will define the appearance of a widget. Styles
746     * vary from widget to widget and may also be defined by other themes
747     * by means of extensions and overlays.
748     *
749     * @param obj The Elementary widget to style
750     * @param style The style name to use
751     *
752     * @see elm_theme_extension_add()
753     * @see elm_theme_overlay_add()
754     *
755     * @ingroup Theme
756     */
757    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
758    /**
759     * Get the style used by the widget
760     *
761     * This gets the style being used for that widget. Note that the string
762     * pointer is only valid as longas the object is valid and the style doesn't
763     * change.
764     *
765     * @param obj The Elementary widget to query for its style
766     * @return The style name used
767     *
768     * @see elm_object_style_set()
769     *
770     * @ingroup Theme
771     */
772    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
773
774    /**
775     * @defgroup Styles Styles
776     *
777     * Widgets can have different styles of look. These generic API's
778     * set styles of widgets, if they support them (and if the theme(s)
779     * do).
780     *
781     * @ref general_functions_example_page "This" example contemplates
782     * some of these functions.
783     */
784
785    /**
786     * Set the disabled state of an Elementary object.
787     *
788     * @param obj The Elementary object to operate on
789     * @param disabled The state to put in in: @c EINA_TRUE for
790     *        disabled, @c EINA_FALSE for enabled
791     *
792     * Elementary objects can be @b disabled, in which state they won't
793     * receive input and, in general, will be themed differently from
794     * their normal state, usually greyed out. Useful for contexts
795     * where you don't want your users to interact with some of the
796     * parts of you interface.
797     *
798     * This sets the state for the widget, either disabling it or
799     * enabling it back.
800     *
801     * @ingroup Styles
802     */
803    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
804
805    /**
806     * Get the disabled state of an Elementary object.
807     *
808     * @param obj The Elementary object to operate on
809     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
810     *            if it's enabled (or on errors)
811     *
812     * This gets the state of the widget, which might be enabled or disabled.
813     *
814     * @ingroup Styles
815     */
816    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
817
818    /**
819     * @defgroup WidgetNavigation Widget Tree Navigation.
820     *
821     * How to check if an Evas Object is an Elementary widget? How to
822     * get the first elementary widget that is parent of the given
823     * object?  These are all covered in widget tree navigation.
824     *
825     * @ref general_functions_example_page "This" example contemplates
826     * some of these functions.
827     */
828
829    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
830
831    /**
832     * Get the first parent of the given object that is an Elementary
833     * widget.
834     *
835     * @param obj the Elementary object to query parent from.
836     * @return the parent object that is an Elementary widget, or @c
837     *         NULL, if it was not found.
838     *
839     * Use this to query for an object's parent widget.
840     *
841     * @note Most of Elementary users wouldn't be mixing non-Elementary
842     * smart objects in the objects tree of an application, as this is
843     * an advanced usage of Elementary with Evas. So, except for the
844     * application's window, which is the root of that tree, all other
845     * objects would have valid Elementary widget parents.
846     *
847     * @ingroup WidgetNavigation
848     */
849    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
850    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
851    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
852
853    EAPI double       elm_scale_get(void);
854    EAPI void         elm_scale_set(double scale);
855    EAPI void         elm_scale_all_set(double scale);
856
857    EAPI Eina_Bool    elm_mirrored_get(void);
858    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
859
860    EAPI Eina_Bool    elm_config_save(void);
861    EAPI void         elm_config_reload(void);
862
863    EAPI const char  *elm_profile_current_get(void);
864    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
865    EAPI void         elm_profile_dir_free(const char *p_dir);
866    EAPI Eina_List   *elm_profile_list_get(void);
867    EAPI void         elm_profile_list_free(Eina_List *l);
868    EAPI void         elm_profile_set(const char *profile);
869    EAPI void         elm_profile_all_set(const char *profile);
870
871    EAPI const char  *elm_engine_current_get(void);
872    EAPI void         elm_engine_set(const char *engine);
873
874   typedef struct _Elm_Text_Class
875     {
876        const char *name;
877        const char *desc;
878     } Elm_Text_Class;
879
880   typedef struct _Elm_Font_Overlay
881     {
882        const char     *text_class;
883        const char     *font;
884        Evas_Font_Size  size;
885     } Elm_Font_Overlay;
886
887   typedef struct _Elm_Font_Properties
888     {
889        const char *name;
890        Eina_List  *styles;
891     } Elm_Font_Properties;
892
893    EAPI const Eina_List     *elm_text_classes_list_get(void);
894    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
895
896    EAPI const Eina_List     *elm_font_overlay_list_get(void);
897    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
898    EAPI void                 elm_font_overlay_unset(const char *text_class);
899    EAPI void                 elm_font_overlay_apply(void);
900    EAPI void                 elm_font_overlay_all_apply(void);
901
902    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
903    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
904    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
905    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
906    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
907    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
908
909    /**
910     * @defgroup Fingers Fingers
911     *
912     * Elementary is designed to be finger-friendly for touchscreens,
913     * and so in addition to scaling for display resolution, it can
914     * also scale based on finger "resolution" (or size). You can then
915     * customize the granularity of the areas meant to receive clicks
916     * on touchscreens.
917     *
918     * Different profiles may have pre-set values for finger sizes.
919     *
920     * @ref general_functions_example_page "This" example contemplates
921     * some of these functions.
922     */
923
924    /**
925     * Get the configured "finger size"
926     *
927     * @return The finger size
928     *
929     * This gets the globally configured finger size, <b>in pixels</b>
930     *
931     * @ingroup Fingers
932     */
933    EAPI Evas_Coord       elm_finger_size_get(void);
934    EAPI void             elm_finger_size_set(Evas_Coord size);
935    EAPI void             elm_finger_size_all_set(Evas_Coord size);
936
937    /**
938     * @defgroup Focus Focus
939     *
940     * An Elementary application has, at all times, one (and only one)
941     * @b focused object. This is what determines where the input
942     * events go to within the application's window. Also, focused
943     * objects can be decorated differently, in order to signal to the
944     * user where the input is, at a given moment.
945     *
946     * Elementary applications also have the concept of <b>focus
947     * chain</b>: one can cycle through all the windows' focusable
948     * objects by input (tab key) or programmatically. The default
949     * focus chain for an application is the one define by the order in
950     * which the widgets where added in code. One will cycle through
951     * top level widgets, and, for each one containg sub-objects, cycle
952     * through them all, before returning to the level
953     * above. Elementary also allows one to set @b custom focus chains
954     * for their applications.
955     *
956     * Besides the focused decoration a widget may exhibit, when it
957     * gets focus, Elementary has a @b global focus highlight object
958     * that can be enabled for a window. If one chooses to do so, this
959     * extra highlight effect will surround the current focused object,
960     * too.
961     *
962     * @note Some Elementary widgets are @b unfocusable, after
963     * creation, by their very nature: they are not meant to be
964     * interacted with input events, but are there just for visual
965     * purposes.
966     *
967     * @ref general_functions_example_page "This" example contemplates
968     * some of these functions.
969     */
970
971    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
972    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
973    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
974    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
975
976    /**
977     * Get the whether an Elementary object has the focus or not.
978     *
979     * @param obj The Elementary object to get the information from
980     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
981     *            not (and on errors).
982     *
983     * @see elm_object_focus()
984     *
985     * @ingroup Focus
986     */
987    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
988
989    /**
990     * Make a given Elementary object the focused one.
991     *
992     * @param obj The Elementary object to make focused.
993     *
994     * @note This object, if it can handle focus, will take the focus
995     * away from the one who had it previously and will, for now on, be
996     * the one receiving input events.
997     *
998     * @see elm_object_focus_get()
999     *
1000     * @ingroup Focus
1001     */
1002    EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1003
1004    /**
1005     * Remove the focus from an Elementary object
1006     *
1007     * @param obj The Elementary to take focus from
1008     *
1009     * This removes the focus from @p obj, passing it back to the
1010     * previous element in the focus chain list.
1011     *
1012     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1013     *
1014     * @ingroup Focus
1015     */
1016    EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1017
1018    /**
1019     * Set the ability for an Element object to be focused
1020     *
1021     * @param obj The Elementary object to operate on
1022     * @param enable @c EINA_TRUE if the object can be focused, @c
1023     *        EINA_FALSE if not (and on errors)
1024     *
1025     * This sets whether the object @p obj is able to take focus or
1026     * not. Unfocusable objects do nothing when programmatically
1027     * focused, being the nearest focusable parent object the one
1028     * really getting focus. Also, when they receive mouse input, they
1029     * will get the event, but not take away the focus from where it
1030     * was previously.
1031     *
1032     * @ingroup Focus
1033     */
1034    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1035
1036    /**
1037     * Get whether an Elementary object is focusable or not
1038     *
1039     * @param obj The Elementary object to operate on
1040     * @return @c EINA_TRUE if the object is allowed to be focused, @c
1041     *             EINA_FALSE if not (and on errors)
1042     *
1043     * @note Objects which are meant to be interacted with by input
1044     * events are created able to be focused, by default. All the
1045     * others are not.
1046     *
1047     * @ingroup Focus
1048     */
1049    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1050
1051    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1052    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1053    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1054    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1055    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1056    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1057    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1058
1059    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
1060    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1061    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1062    EAPI double           elm_scroll_bounce_friction_get(void);
1063    EAPI void             elm_scroll_bounce_friction_set(double friction);
1064    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
1065    EAPI double           elm_scroll_page_scroll_friction_get(void);
1066    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
1067    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
1068    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
1069    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
1070    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
1071    EAPI double           elm_scroll_zoom_friction_get(void);
1072    EAPI void             elm_scroll_zoom_friction_set(double friction);
1073    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
1074    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
1075    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1076    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1077    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
1078    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1079    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1080    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
1081    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1082    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1083    EAPI double           elm_scroll_thumbscroll_friction_get(void);
1084    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
1085    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
1086    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
1087    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
1088    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
1089
1090    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1091    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1092    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1093    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1094    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1095    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1096    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1097    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1098
1099    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1100    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);
1101    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);
1102
1103    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1104    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1105
1106    /**
1107     * Adjust size of an element for finger usage.
1108     *
1109     * @param times_w How many fingers should fit horizontally
1110     * @param w Pointer to the width size to adjust
1111     * @param times_h How many fingers should fit vertically
1112     * @param h Pointer to the height size to adjust
1113     *
1114     * This takes width and height sizes (in pixels) as input and a
1115     * size multiple (which is how many fingers you want to place
1116     * within the area, being "finger" the size set by
1117     * elm_finger_size_set()), and adjusts the size to be large enough
1118     * to accommodate the resulting size -- if it doesn't already
1119     * accommodate it. On return the @p w and @p h sizes pointed to by
1120     * these parameters will be modified, on those conditions.
1121     *
1122     * @note This is kind of a low level Elementary call, most useful
1123     * on size evaluation times for widgets. An external user wouldn't
1124     * be calling, most of the time.
1125     *
1126     * @ingroup Fingers
1127     */
1128    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1129
1130    EAPI double           elm_longpress_timeout_get(void);
1131    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
1132
1133    /* debug
1134     * don't use it unless you are sure
1135     */
1136    EAPI void             elm_object_tree_dump(const Evas_Object *top);
1137    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1138
1139
1140    /* theme */
1141    /**
1142     * @defgroup Theme Theme
1143     *
1144     * Elementary uses Edje to theme its widgets, naturally. But for the most
1145     * part this is hidden behind a simpler interface that lets the user set
1146     * extensions and choose the style of widgets in a much easier way.
1147     *
1148     * Instead of thinking in terms of paths to Edje files and their groups
1149     * each time you want to change the appearance of a widget, Elementary
1150     * works so you can add any theme file with extensions or replace the
1151     * main theme at one point in the application, and then just set the style
1152     * of widgets with elm_object_style_set() and related functions. Elementary
1153     * will then look in its list of themes for a matching group and apply it,
1154     * and when the theme changes midway through the application, all widgets
1155     * will be updated accordingly.
1156     *
1157     * There are three concepts you need to know to understand how Elementary
1158     * theming works: default theme, extensions and overlays.
1159     *
1160     * Default theme, obviously enough, is the one that provides the default
1161     * look of all widgets. End users can change the theme used by Elementary
1162     * by setting the @c ELM_THEME environment variable before running an
1163     * application, or globally for all programs using the @c elementary_config
1164     * utility. Applications can change the default theme using elm_theme_set(),
1165     * but this can go against the user wishes, so it's not an adviced practice.
1166     *
1167     * Ideally, applications should find everything they need in the already
1168     * provided theme, but there may be occasions when that's not enough and
1169     * custom styles are required to correctly express the idea. For this
1170     * cases, Elementary has extensions.
1171     *
1172     * Extensions allow the application developer to write styles of its own
1173     * to apply to some widgets. This requires knowledge of how each widget
1174     * is themed, as extensions will always replace the entire group used by
1175     * the widget, so important signals and parts need to be there for the
1176     * object to behave properly (see documentation of Edje for details).
1177     * Once the theme for the extension is done, the application needs to add
1178     * it to the list of themes Elementary will look into, using
1179     * elm_theme_extension_add(), and set the style of the desired widgets as
1180     * he would normally with elm_object_style_set().
1181     *
1182     * Overlays, on the other hand, can replace the look of all widgets by
1183     * overriding the default style. Like extensions, it's up to the application
1184     * developer to write the theme for the widgets it wants, the difference
1185     * being that when looking for the theme, Elementary will check first the
1186     * list of overlays, then the set theme and lastly the list of extensions,
1187     * so with overlays it's possible to replace the default view and every
1188     * widget will be affected. This is very much alike to setting the whole
1189     * theme for the application and will probably clash with the end user
1190     * options, not to mention the risk of ending up with not matching styles
1191     * across the program. Unless there's a very special reason to use them,
1192     * overlays should be avoided for the resons exposed before.
1193     *
1194     * All these theme lists are handled by ::Elm_Theme instances. Elementary
1195     * keeps one default internally and every function that receives one of
1196     * these can be called with NULL to refer to this default (except for
1197     * elm_theme_free()). It's possible to create a new instance of a
1198     * ::Elm_Theme to set other theme for a specific widget (and all of its
1199     * children), but this is as discouraged, if not even more so, than using
1200     * overlays. Don't use this unless you really know what you are doing.
1201     *
1202     * But to be less negative about things, you can look at the following
1203     * examples:
1204     * @li @ref theme_example_01 "Using extensions"
1205     * @li @ref theme_example_02 "Using overlays"
1206     *
1207     * @{
1208     */
1209    /**
1210     * @typedef Elm_Theme
1211     *
1212     * Opaque handler for the list of themes Elementary looks for when
1213     * rendering widgets.
1214     *
1215     * Stay out of this unless you really know what you are doing. For most
1216     * cases, sticking to the default is all a developer needs.
1217     */
1218    typedef struct _Elm_Theme Elm_Theme;
1219
1220    /**
1221     * Create a new specific theme
1222     *
1223     * This creates an empty specific theme that only uses the default theme. A
1224     * specific theme has its own private set of extensions and overlays too
1225     * (which are empty by default). Specific themes do not fall back to themes
1226     * of parent objects. They are not intended for this use. Use styles, overlays
1227     * and extensions when needed, but avoid specific themes unless there is no
1228     * other way (example: you want to have a preview of a new theme you are
1229     * selecting in a "theme selector" window. The preview is inside a scroller
1230     * and should display what the theme you selected will look like, but not
1231     * actually apply it yet. The child of the scroller will have a specific
1232     * theme set to show this preview before the user decides to apply it to all
1233     * applications).
1234     */
1235    EAPI Elm_Theme       *elm_theme_new(void);
1236    /**
1237     * Free a specific theme
1238     *
1239     * @param th The theme to free
1240     *
1241     * This frees a theme created with elm_theme_new().
1242     */
1243    EAPI void             elm_theme_free(Elm_Theme *th);
1244    /**
1245     * Copy the theme fom the source to the destination theme
1246     *
1247     * @param th The source theme to copy from
1248     * @param thdst The destination theme to copy data to
1249     *
1250     * This makes a one-time static copy of all the theme config, extensions
1251     * and overlays from @p th to @p thdst. If @p th references a theme, then
1252     * @p thdst is also set to reference it, with all the theme settings,
1253     * overlays and extensions that @p th had.
1254     */
1255    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1256    /**
1257     * Tell the source theme to reference the ref theme
1258     *
1259     * @param th The theme that will do the referencing
1260     * @param thref The theme that is the reference source
1261     *
1262     * This clears @p th to be empty and then sets it to refer to @p thref
1263     * so @p th acts as an override to @p thref, but where its overrides
1264     * don't apply, it will fall through to @pthref for configuration.
1265     */
1266    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1267    /**
1268     * Return the theme referred to
1269     *
1270     * @param th The theme to get the reference from
1271     * @return The referenced theme handle
1272     *
1273     * This gets the theme set as the reference theme by elm_theme_ref_set().
1274     * If no theme is set as a reference, NULL is returned.
1275     */
1276    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
1277    /**
1278     * Return the default theme
1279     *
1280     * @return The default theme handle
1281     *
1282     * This returns the internal default theme setup handle that all widgets
1283     * use implicitly unless a specific theme is set. This is also often use
1284     * as a shorthand of NULL.
1285     */
1286    EAPI Elm_Theme       *elm_theme_default_get(void);
1287    /**
1288     * Prepends a theme overlay to the list of overlays
1289     *
1290     * @param th The theme to add to, or if NULL, the default theme
1291     * @param item The Edje file path to be used
1292     *
1293     * Use this if your application needs to provide some custom overlay theme
1294     * (An Edje file that replaces some default styles of widgets) where adding
1295     * new styles, or changing system theme configuration is not possible. Do
1296     * NOT use this instead of a proper system theme configuration. Use proper
1297     * configuration files, profiles, environment variables etc. to set a theme
1298     * so that the theme can be altered by simple confiugration by a user. Using
1299     * this call to achieve that effect is abusing the API and will create lots
1300     * of trouble.
1301     *
1302     * @see elm_theme_extension_add()
1303     */
1304    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
1305    /**
1306     * Delete a theme overlay from the list of overlays
1307     *
1308     * @param th The theme to delete from, or if NULL, the default theme
1309     * @param item The name of the theme overlay
1310     *
1311     * @see elm_theme_overlay_add()
1312     */
1313    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
1314    /**
1315     * Appends a theme extension to the list of extensions.
1316     *
1317     * @param th The theme to add to, or if NULL, the default theme
1318     * @param item The Edje file path to be used
1319     *
1320     * This is intended when an application needs more styles of widgets or new
1321     * widget themes that the default does not provide (or may not provide). The
1322     * application has "extended" usage by coming up with new custom style names
1323     * for widgets for specific uses, but as these are not "standard", they are
1324     * not guaranteed to be provided by a default theme. This means the
1325     * application is required to provide these extra elements itself in specific
1326     * Edje files. This call adds one of those Edje files to the theme search
1327     * path to be search after the default theme. The use of this call is
1328     * encouraged when default styles do not meet the needs of the application.
1329     * Use this call instead of elm_theme_overlay_add() for almost all cases.
1330     *
1331     * @see elm_object_style_set()
1332     */
1333    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
1334    /**
1335     * Deletes a theme extension from the list of extensions.
1336     *
1337     * @param th The theme to delete from, or if NULL, the default theme
1338     * @param item The name of the theme extension
1339     *
1340     * @see elm_theme_extension_add()
1341     */
1342    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
1343    /**
1344     * Set the theme search order for the given theme
1345     *
1346     * @param th The theme to set the search order, or if NULL, the default theme
1347     * @param theme Theme search string
1348     *
1349     * This sets the search string for the theme in path-notation from first
1350     * theme to search, to last, delimited by the : character. Example:
1351     *
1352     * "shiny:/path/to/file.edj:default"
1353     *
1354     * See the ELM_THEME environment variable for more information.
1355     *
1356     * @see elm_theme_get()
1357     * @see elm_theme_list_get()
1358     */
1359    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
1360    /**
1361     * Return the theme search order
1362     *
1363     * @param th The theme to get the search order, or if NULL, the default theme
1364     * @return The internal search order path
1365     *
1366     * This function returns a colon separated string of theme elements as
1367     * returned by elm_theme_list_get().
1368     *
1369     * @see elm_theme_set()
1370     * @see elm_theme_list_get()
1371     */
1372    EAPI const char      *elm_theme_get(Elm_Theme *th);
1373    /**
1374     * Return a list of theme elements to be used in a theme.
1375     *
1376     * @param th Theme to get the list of theme elements from.
1377     * @return The internal list of theme elements
1378     *
1379     * This returns the internal list of theme elements (will only be valid as
1380     * long as the theme is not modified by elm_theme_set() or theme is not
1381     * freed by elm_theme_free(). This is a list of strings which must not be
1382     * altered as they are also internal. If @p th is NULL, then the default
1383     * theme element list is returned.
1384     *
1385     * A theme element can consist of a full or relative path to a .edj file,
1386     * or a name, without extension, for a theme to be searched in the known
1387     * theme paths for Elemementary.
1388     *
1389     * @see elm_theme_set()
1390     * @see elm_theme_get()
1391     */
1392    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1393    /**
1394     * Return the full patrh for a theme element
1395     *
1396     * @param f The theme element name
1397     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1398     * @return The full path to the file found.
1399     *
1400     * This returns a string you should free with free() on success, NULL on
1401     * failure. This will search for the given theme element, and if it is a
1402     * full or relative path element or a simple searchable name. The returned
1403     * path is the full path to the file, if searched, and the file exists, or it
1404     * is simply the full path given in the element or a resolved path if
1405     * relative to home. The @p in_search_path boolean pointed to is set to
1406     * EINA_TRUE if the file was a searchable file andis in the search path,
1407     * and EINA_FALSE otherwise.
1408     */
1409    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1410    /**
1411     * Flush the current theme.
1412     *
1413     * @param th Theme to flush
1414     *
1415     * This flushes caches that let elementary know where to find theme elements
1416     * in the given theme. If @p th is NULL, then the default theme is flushed.
1417     * Call this function if source theme data has changed in such a way as to
1418     * make any caches Elementary kept invalid.
1419     */
1420    EAPI void             elm_theme_flush(Elm_Theme *th);
1421    /**
1422     * This flushes all themes (default and specific ones).
1423     *
1424     * This will flush all themes in the current application context, by calling
1425     * elm_theme_flush() on each of them.
1426     */
1427    EAPI void             elm_theme_full_flush(void);
1428    /**
1429     * Set the theme for all elementary using applications on the current display
1430     *
1431     * @param theme The name of the theme to use. Format same as the ELM_THEME
1432     * environment variable.
1433     */
1434    EAPI void             elm_theme_all_set(const char *theme);
1435    /**
1436     * Return a list of theme elements in the theme search path
1437     *
1438     * @return A list of strings that are the theme element names.
1439     *
1440     * This lists all available theme files in the standard Elementary search path
1441     * for theme elements, and returns them in alphabetical order as theme
1442     * element names in a list of strings. Free this with
1443     * elm_theme_name_available_list_free() when you are done with the list.
1444     */
1445    EAPI Eina_List       *elm_theme_name_available_list_new(void);
1446    /**
1447     * Free the list returned by elm_theme_name_available_list_new()
1448     *
1449     * This frees the list of themes returned by
1450     * elm_theme_name_available_list_new(). Once freed the list should no longer
1451     * be used. a new list mys be created.
1452     */
1453    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
1454    /**
1455     * Set a specific theme to be used for this object and its children
1456     *
1457     * @param obj The object to set the theme on
1458     * @param th The theme to set
1459     *
1460     * This sets a specific theme that will be used for the given object and any
1461     * child objects it has. If @p th is NULL then the theme to be used is
1462     * cleared and the object will inherit its theme from its parent (which
1463     * ultimately will use the default theme if no specific themes are set).
1464     *
1465     * Use special themes with great care as this will annoy users and make
1466     * configuration difficult. Avoid any custom themes at all if it can be
1467     * helped.
1468     */
1469    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1470    /**
1471     * Get the specific theme to be used
1472     *
1473     * @param obj The object to get the specific theme from
1474     * @return The specifc theme set.
1475     *
1476     * This will return a specific theme set, or NULL if no specific theme is
1477     * set on that object. It will not return inherited themes from parents, only
1478     * the specific theme set for that specific object. See elm_object_theme_set()
1479     * for more information.
1480     */
1481    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1482    /**
1483     * @}
1484     */
1485
1486    /* win */
1487    typedef enum _Elm_Win_Type
1488      {
1489         ELM_WIN_BASIC,
1490         ELM_WIN_DIALOG_BASIC,
1491         ELM_WIN_DESKTOP,
1492         ELM_WIN_DOCK,
1493         ELM_WIN_TOOLBAR,
1494         ELM_WIN_MENU,
1495         ELM_WIN_UTILITY,
1496         ELM_WIN_SPLASH,
1497         ELM_WIN_DROPDOWN_MENU,
1498         ELM_WIN_POPUP_MENU,
1499         ELM_WIN_TOOLTIP,
1500         ELM_WIN_NOTIFICATION,
1501         ELM_WIN_COMBO,
1502         ELM_WIN_DND,
1503         ELM_WIN_INLINED_IMAGE,
1504      } Elm_Win_Type;
1505
1506    typedef enum _Elm_Win_Keyboard_Mode
1507      {
1508         ELM_WIN_KEYBOARD_UNKNOWN,
1509         ELM_WIN_KEYBOARD_OFF,
1510         ELM_WIN_KEYBOARD_ON,
1511         ELM_WIN_KEYBOARD_ALPHA,
1512         ELM_WIN_KEYBOARD_NUMERIC,
1513         ELM_WIN_KEYBOARD_PIN,
1514         ELM_WIN_KEYBOARD_PHONE_NUMBER,
1515         ELM_WIN_KEYBOARD_HEX,
1516         ELM_WIN_KEYBOARD_TERMINAL,
1517         ELM_WIN_KEYBOARD_PASSWORD,
1518         ELM_WIN_KEYBOARD_IP,
1519         ELM_WIN_KEYBOARD_HOST,
1520         ELM_WIN_KEYBOARD_FILE,
1521         ELM_WIN_KEYBOARD_URL,
1522         ELM_WIN_KEYBOARD_KEYPAD,
1523         ELM_WIN_KEYBOARD_J2ME
1524      } Elm_Win_Keyboard_Mode;
1525
1526    typedef enum _Elm_Illume_Command
1527      {
1528         ELM_ILLUME_COMMAND_FOCUS_BACK,
1529         ELM_ILLUME_COMMAND_FOCUS_FORWARD,
1530         ELM_ILLUME_COMMAND_FOCUS_HOME,
1531         ELM_ILLUME_COMMAND_CLOSE
1532      } Elm_Illume_Command;
1533
1534    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1535    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1536    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1537    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1538    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1539    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1540    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1541    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1542    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1543    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
1544    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
1545    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1546    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
1547    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1548    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
1549    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1550    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
1551    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1552    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
1553    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1554    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
1555    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1556    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
1557    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1558    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
1559    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1560    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
1561    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1562    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1563    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
1564    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1565    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
1566    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1567    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
1568    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1569    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
1570    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1571    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1572    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1573    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
1574    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1575    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
1576    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1577    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip); EINA_ARG_NONNULL(1);
1578    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params); EINA_ARG_NONNULL(1);
1579    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
1580    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1581    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1582    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1583    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1584    /*...
1585     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
1586     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
1587     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
1588     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
1589     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
1590     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
1591     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
1592     *
1593     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
1594     * (blank mouse, private mouse obj, defaultmouse)
1595     *
1596     */
1597    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
1598    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1599    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
1600    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1601
1602    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
1603
1604    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
1605    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1606    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
1607    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1608    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1609    /* available styles:
1610     * default
1611     * minimal
1612     * minimal_vertical
1613     */
1614    /* X specific calls - won't work on non-x engines (return 0) */
1615    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1616    /* smart callbacks called:
1617     * "delete,request" - the user requested to delete the window
1618     * "focus,in" - window got focus
1619     * "focus,out" - window lost focus
1620     * "moved" - window that holds the canvas was moved
1621     */
1622
1623    /**
1624     * @defgroup Bg Bg
1625     *
1626     * @brief Background object, used for setting a solid color, image or Edje
1627     * group as background to a window or any container object.
1628     *
1629     * The bg object is used for setting a solid background to a window or
1630     * packing into any container object. It works just like an image, but has
1631     * some properties useful to a background, like setting it to tiled,
1632     * centered, scaled or stretched.
1633     *
1634     * Here is some sample code using it:
1635     * @li @ref bg_01_example_page
1636     * @li @ref bg_02_example_page
1637     * @li @ref bg_03_example_page
1638     */
1639
1640    /* bg */
1641    typedef enum _Elm_Bg_Option
1642      {
1643         ELM_BG_OPTION_CENTER,  /**< center the background */
1644         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
1645         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
1646         ELM_BG_OPTION_TILE     /**< tile background at its original size */
1647      } Elm_Bg_Option;
1648
1649    /**
1650     * Add a new background to the parent
1651     *
1652     * @param parent The parent object
1653     * @return The new object or NULL if it cannot be created
1654     *
1655     * @ingroup Bg
1656     */
1657    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1658
1659    /**
1660     * Set the file (image or edje) used for the background
1661     *
1662     * @param obj The bg object
1663     * @param file The file path
1664     * @param group Optional key (group in Edje) within the file
1665     *
1666     * This sets the image file used in the background object. The image (or edje)
1667     * will be stretched (retaining aspect if its an image file) to completely fill
1668     * the bg object. This may mean some parts are not visible.
1669     *
1670     * @note  Once the image of @p obj is set, a previously set one will be deleted,
1671     * even if @p file is NULL.
1672     *
1673     * @ingroup Bg
1674     */
1675    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
1676
1677    /**
1678     * Get the file (image or edje) used for the background
1679     *
1680     * @param obj The bg object
1681     * @param file The file path
1682     * @param group Optional key (group in Edje) within the file
1683     *
1684     * @ingroup Bg
1685     */
1686    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1687
1688    /**
1689     * Set the option used for the background image
1690     *
1691     * @param obj The bg object
1692     * @param option The desired background option (TILE, SCALE)
1693     *
1694     * This sets the option used for manipulating the display of the background
1695     * image. The image can be tiled or scaled.
1696     *
1697     * @ingroup Bg
1698     */
1699    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
1700
1701    /**
1702     * Get the option used for the background image
1703     *
1704     * @param obj The bg object
1705     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
1706     *
1707     * @ingroup Bg
1708     */
1709    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1710    /**
1711     * Set the option used for the background color
1712     *
1713     * @param obj The bg object
1714     * @param r
1715     * @param g
1716     * @param b
1717     *
1718     * This sets the color used for the background rectangle. Its range goes
1719     * from 0 to 255.
1720     *
1721     * @ingroup Bg
1722     */
1723    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
1724    /**
1725     * Get the option used for the background color
1726     *
1727     * @param obj The bg object
1728     * @param r
1729     * @param g
1730     * @param b
1731     *
1732     * @ingroup Bg
1733     */
1734    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
1735
1736    /**
1737     * Set the overlay object used for the background object.
1738     *
1739     * @param obj The bg object
1740     * @param overlay The overlay object
1741     *
1742     * This provides a way for elm_bg to have an 'overlay' that will be on top
1743     * of the bg. Once the over object is set, a previously set one will be
1744     * deleted, even if you set the new one to NULL. If you want to keep that
1745     * old content object, use the elm_bg_overlay_unset() function.
1746     *
1747     * @ingroup Bg
1748     */
1749
1750    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
1751
1752    /**
1753     * Get the overlay object used for the background object.
1754     *
1755     * @param obj The bg object
1756     * @return The content that is being used
1757     *
1758     * Return the content object which is set for this widget
1759     *
1760     * @ingroup Bg
1761     */
1762    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1763
1764    /**
1765     * Get the overlay object used for the background object.
1766     *
1767     * @param obj The bg object
1768     * @return The content that was being used
1769     *
1770     * Unparent and return the overlay object which was set for this widget
1771     *
1772     * @ingroup Bg
1773     */
1774    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1775
1776    /**
1777     * Set the size of the pixmap representation of the image.
1778     *
1779     * This option just makes sense if an image is going to be set in the bg.
1780     *
1781     * @param obj The bg object
1782     * @param w The new width of the image pixmap representation.
1783     * @param h The new height of the image pixmap representation.
1784     *
1785     * This function sets a new size for pixmap representation of the given bg
1786     * image. It allows the image to be loaded already in the specified size,
1787     * reducing the memory usage and load time when loading a big image with load
1788     * size set to a smaller size.
1789     *
1790     * NOTE: this is just a hint, the real size of the pixmap may differ
1791     * depending on the type of image being loaded, being bigger than requested.
1792     *
1793     * @ingroup Bg
1794     */
1795    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
1796    /* smart callbacks called:
1797     */
1798
1799    /* icon */
1800    typedef enum _Elm_Icon_Lookup_Order
1801      {
1802         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
1803         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
1804         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
1805         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
1806      } Elm_Icon_Lookup_Order;
1807
1808    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1809    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1810    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1811    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1812    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
1813    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1814    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1815    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1816    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1817    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1818    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1819    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1820    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1821    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1822    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1823    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1824    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
1825    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1826    /* smart callbacks called:
1827     * "clicked" - the user clicked the icon
1828     */
1829
1830    /* image */
1831    typedef enum _Elm_Image_Orient
1832      {
1833         ELM_IMAGE_ORIENT_NONE,
1834         ELM_IMAGE_ROTATE_90_CW,
1835         ELM_IMAGE_ROTATE_180_CW,
1836         ELM_IMAGE_ROTATE_90_CCW,
1837         ELM_IMAGE_FLIP_HORIZONTAL,
1838         ELM_IMAGE_FLIP_VERTICAL,
1839         ELM_IMAGE_FLIP_TRANSPOSE,
1840         ELM_IMAGE_FLIP_TRANSVERSE
1841      } Elm_Image_Orient;
1842    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1843    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
1844    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
1845    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
1846    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1847    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
1848    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
1849    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1850    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
1851    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
1852    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
1853    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1854    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
1855    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1856    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
1857    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1858    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
1859    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1860    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1861    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
1862    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1863
1864    /* smart callbacks called:
1865     * "clicked" - the user clicked the image
1866     */
1867
1868    /* glview */
1869    typedef void (*Elm_GLView_Func)(Evas_Object *obj);
1870
1871    typedef enum _Elm_GLView_Mode
1872      {
1873         ELM_GLVIEW_ALPHA   = 1,
1874         ELM_GLVIEW_DEPTH   = 2,
1875         ELM_GLVIEW_STENCIL = 4
1876      } Elm_GLView_Mode;
1877
1878    /**
1879     * Defines a policy for the glview resizing.
1880     *
1881     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
1882     */
1883    typedef enum _Elm_GLView_Resize_Policy
1884      {
1885         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
1886         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
1887      } Elm_GLView_Resize_Policy;
1888
1889    typedef enum _Elm_GLView_Render_Policy
1890      {
1891         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
1892         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
1893      } Elm_GLView_Render_Policy;
1894
1895
1896    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1897    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
1898    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
1899    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1900    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
1901    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
1902    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
1903    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1904    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1905    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1906    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
1907    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
1908
1909    /* box */
1910    /**
1911     * @defgroup Box Box
1912     *
1913     * A box arranges objects in a linear fashion, governed by a layout function
1914     * that defines the details of this arrangement.
1915     *
1916     * By default, the box will use an internal function to set the layout to
1917     * a single row, either vertical or horizontal. This layout is affected
1918     * by a number of parameters, such as the homogeneous flag set by
1919     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
1920     * elm_box_align_set() and the hints set to each object in the box.
1921     *
1922     * For this default layout, it's possible to change the orientation with
1923     * elm_box_horizontal_set(). The box will start in the vertical orientation,
1924     * placing its elements ordered from top to bottom. When horizontal is set,
1925     * the order will go from left to right. If the box is set to be
1926     * homogeneous, every object in it will be assigned the same space, that
1927     * of the largest object. Padding can be used to set some spacing between
1928     * the cell given to each object. The alignment of the box, set with
1929     * elm_box_align_set(), determines how the bounding box of all the elements
1930     * will be placed within the space given to the box widget itself.
1931     *
1932     * The size hints of each object also affect how they are placed and sized
1933     * within the box. evas_object_size_hint_min_set() will give the minimum
1934     * size the object can have, and the box will use it as the basis for all
1935     * latter calculations. Elementary widgets set their own minimum size as
1936     * needed, so there's rarely any need to use it manually.
1937     *
1938     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
1939     * used to tell whether the object will be allocated the minimum size it
1940     * needs or if the space given to it should be expanded. It's important
1941     * to realize that expanding the size given to the object is not the same
1942     * thing as resizing the object. It could very well end being a small
1943     * widget floating in a much larger empty space. If not set, the weight
1944     * for objects will normally be 0.0 for both axis, meaning the widget will
1945     * not be expanded. To take as much space possible, set the weight to
1946     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
1947     *
1948     * Besides how much space each object is allocated, it's possible to control
1949     * how the widget will be placed within that space using
1950     * evas_object_size_hint_align_set(). By default, this value will be 0.5
1951     * for both axis, meaning the object will be centered, but any value from
1952     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
1953     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
1954     * is -1.0, means the object will be resized to fill the entire space it
1955     * was allocated.
1956     *
1957     * In addition, customized functions to define the layout can be set, which
1958     * allow the application developer to organize the objects within the box
1959     * in any number of ways.
1960     *
1961     * The special elm_box_layout_transition() function can be used
1962     * to switch from one layout to another, animating the motion of the
1963     * children of the box.
1964     *
1965     * @note Objects should not be added to box objects using _add() calls.
1966     *
1967     * @{
1968     */
1969    /**
1970     * @typedef Elm_Box_Transition
1971     *
1972     * Opaque handler containing the parameters to perform an animated
1973     * transition of the layout the box uses.
1974     *
1975     * @see elm_box_transition_new()
1976     * @see elm_box_layout_set()
1977     * @see elm_box_layout_transition()
1978     */
1979    typedef struct _Elm_Box_Transition Elm_Box_Transition;
1980
1981    /**
1982     * Add a new box to the parent
1983     *
1984     * By default, the box will be in vertical mode and non-homogeneous.
1985     *
1986     * @param parent The parent object
1987     * @return The new object or NULL if it cannot be created
1988     */
1989    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
1990    /**
1991     * Set the horizontal orientation
1992     *
1993     * By default, box object arranges their contents vertically from top to
1994     * bottom.
1995     * By calling this function with @p horizontal as EINA_TRUE, the box will
1996     * become horizontal, arranging contents from left to right.
1997     *
1998     * @note This flag is ignored if a custom layout function is set.
1999     *
2000     * @param obj The box object
2001     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2002     * EINA_FALSE = vertical)
2003     */
2004    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2005    /**
2006     * Get the horizontal orientation
2007     *
2008     * @param obj The box object
2009     * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2010     */
2011    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2012    /**
2013     * Set the box to arrange its children homogeneously
2014     *
2015     * If enabled, homogeneous layout makes all items the same size, according
2016     * to the size of the largest of its children.
2017     *
2018     * @note This flag is ignored if a custom layout function is set.
2019     *
2020     * @param obj The box object
2021     * @param homogeneous The homogeneous flag
2022     */
2023    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2024    /**
2025     * Get whether the box is using homogeneous mode or not
2026     *
2027     * @param obj The box object
2028     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2029     */
2030    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2031    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2032    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2033    /**
2034     * Add an object to the beginning of the pack list
2035     *
2036     * Pack @p subobj into the box @p obj, placing it first in the list of
2037     * children objects. The actual position the object will get on screen
2038     * depends on the layout used. If no custom layout is set, it will be at
2039     * the top or left, depending if the box is vertical or horizontal,
2040     * respectively.
2041     *
2042     * @param obj The box object
2043     * @param subobj The object to add to the box
2044     *
2045     * @see elm_box_pack_end()
2046     * @see elm_box_pack_before()
2047     * @see elm_box_pack_after()
2048     * @see elm_box_unpack()
2049     * @see elm_box_unpack_all()
2050     * @see elm_box_clear()
2051     */
2052    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2053    /**
2054     * Add an object at the end of the pack list
2055     *
2056     * Pack @p subobj into the box @p obj, placing it last in the list of
2057     * children objects. The actual position the object will get on screen
2058     * depends on the layout used. If no custom layout is set, it will be at
2059     * the bottom or right, depending if the box is vertical or horizontal,
2060     * respectively.
2061     *
2062     * @param obj The box object
2063     * @param subobj The object to add to the box
2064     *
2065     * @see elm_box_pack_start()
2066     * @see elm_box_pack_before()
2067     * @see elm_box_pack_after()
2068     * @see elm_box_unpack()
2069     * @see elm_box_unpack_all()
2070     * @see elm_box_clear()
2071     */
2072    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2073    /**
2074     * Adds an object to the box before the indicated object
2075     *
2076     * This will add the @p subobj to the box indicated before the object
2077     * indicated with @p before. If @p before is not already in the box, results
2078     * are undefined. Before means either to the left of the indicated object or
2079     * above it depending on orientation.
2080     *
2081     * @param obj The box object
2082     * @param subobj The object to add to the box
2083     * @param before The object before which to add it
2084     *
2085     * @see elm_box_pack_start()
2086     * @see elm_box_pack_end()
2087     * @see elm_box_pack_after()
2088     * @see elm_box_unpack()
2089     * @see elm_box_unpack_all()
2090     * @see elm_box_clear()
2091     */
2092    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2093    /**
2094     * Adds an object to the box after the indicated object
2095     *
2096     * This will add the @p subobj to the box indicated after the object
2097     * indicated with @p after. If @p after is not already in the box, results
2098     * are undefined. After means either to the right of the indicated object or
2099     * below it depending on orientation.
2100     *
2101     * @param obj The box object
2102     * @param subobj The object to add to the box
2103     * @param after The object after which to add it
2104     *
2105     * @see elm_box_pack_start()
2106     * @see elm_box_pack_end()
2107     * @see elm_box_pack_before()
2108     * @see elm_box_unpack()
2109     * @see elm_box_unpack_all()
2110     * @see elm_box_clear()
2111     */
2112    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2113    /**
2114     * Clear the box of all children
2115     *
2116     * Remove all the elements contained by the box, deleting the respective
2117     * objects.
2118     *
2119     * @param obj The box object
2120     *
2121     * @see elm_box_unpack()
2122     * @see elm_box_unpack_all()
2123     */
2124    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2125    /**
2126     * Unpack a box item
2127     *
2128     * Remove the object given by @p subobj from the box @p obj without
2129     * deleting it.
2130     *
2131     * @param obj The box object
2132     *
2133     * @see elm_box_unpack_all()
2134     * @see elm_box_clear()
2135     */
2136    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2137    /**
2138     * Remove all items from the box, without deleting them
2139     *
2140     * Clear the box from all children, but don't delete the respective objects.
2141     * If no other references of the box children exist, the objects will never
2142     * be deleted, and thus the application will leak the memory. Make sure
2143     * when using this function that you hold a reference to all the objects
2144     * in the box @p obj.
2145     *
2146     * @param obj The box object
2147     *
2148     * @see elm_box_clear()
2149     * @see elm_box_unpack()
2150     */
2151    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2152    /**
2153     * Retrieve a list of the objects packed into the box
2154     *
2155     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2156     * The order of the list corresponds to the packing order the box uses.
2157     *
2158     * You must free this list with eina_list_free() once you are done with it.
2159     *
2160     * @param obj The box object
2161     */
2162    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2163    /**
2164     * Set the space (padding) between the box's elements.
2165     *
2166     * Extra space in pixels that will be added between a box child and its
2167     * neighbors after its containing cell has been calculated. This padding
2168     * is set for all elements in the box, besides any possible padding that
2169     * individual elements may have through their size hints.
2170     *
2171     * @param obj The box object
2172     * @param horizontal The horizontal space between elements
2173     * @param vertical The vertical space between elements
2174     */
2175    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2176    /**
2177     * Get the space (padding) between the box's elements.
2178     *
2179     * @param obj The box object
2180     * @param horizontal The horizontal space between elements
2181     * @param vertical The vertical space between elements
2182     *
2183     * @see elm_box_padding_set()
2184     */
2185    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2186    /**
2187     * Set the alignment of the whole bouding box of contents.
2188     *
2189     * Sets how the bounding box containing all the elements of the box, after
2190     * their sizes and position has been calculated, will be aligned within
2191     * the space given for the whole box widget.
2192     *
2193     * @param obj The box object
2194     * @param horizontal The horizontal alignment of elements
2195     * @param vertical The vertical alignment of elements
2196     */
2197    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2198    /**
2199     * Get the alignment of the whole bouding box of contents.
2200     *
2201     * @param obj The box object
2202     * @param horizontal The horizontal alignment of elements
2203     * @param vertical The vertical alignment of elements
2204     *
2205     * @see elm_box_align_set()
2206     */
2207    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2208
2209    /**
2210     * Set the layout defining function to be used by the box
2211     *
2212     * Whenever anything changes that requires the box in @p obj to recalculate
2213     * the size and position of its elements, the function @p cb will be called
2214     * to determine what the layout of the children will be.
2215     *
2216     * Once a custom function is set, everything about the children layout
2217     * is defined by it. The flags set by elm_box_horizontal_set() and
2218     * elm_box_homogeneous_set() no longer have any meaning, and the values
2219     * given by elm_box_padding_set() and elm_box_align_set() are up to this
2220     * layout function to decide if they are used and how. These last two
2221     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2222     * passed to @p cb. The @c Evas_Object the function receives is not the
2223     * Elementary widget, but the internal Evas Box it uses, so none of the
2224     * functions described here can be used on it.
2225     *
2226     * Any of the layout functions in @c Evas can be used here, as well as the
2227     * special elm_box_layout_transition().
2228     *
2229     * The final @p data argument received by @p cb is the same @p data passed
2230     * here, and the @p free_data function will be called to free it
2231     * whenever the box is destroyed or another layout function is set.
2232     *
2233     * Setting @p cb to NULL will revert back to the default layout function.
2234     *
2235     * @param obj The box object
2236     * @param cb The callback function used for layout
2237     * @param data Data that will be passed to layout function
2238     * @param free_data Function called to free @p data
2239     *
2240     * @see elm_box_layout_transition()
2241     */
2242    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);
2243    /**
2244     * Special layout function that animates the transition from one layout to another
2245     *
2246     * Normally, when switching the layout function for a box, this will be
2247     * reflected immediately on screen on the next render, but it's also
2248     * possible to do this through an animated transition.
2249     *
2250     * This is done by creating an ::Elm_Box_Transition and setting the box
2251     * layout to this function.
2252     *
2253     * For example:
2254     * @code
2255     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2256     *                            evas_object_box_layout_vertical, // start
2257     *                            NULL, // data for initial layout
2258     *                            NULL, // free function for initial data
2259     *                            evas_object_box_layout_horizontal, // end
2260     *                            NULL, // data for final layout
2261     *                            NULL, // free function for final data
2262     *                            anim_end, // will be called when animation ends
2263     *                            NULL); // data for anim_end function\
2264     * elm_box_layout_set(box, elm_box_layout_transition, t,
2265     *                    elm_box_transition_free);
2266     * @endcode
2267     *
2268     * @note This function can only be used with elm_box_layout_set(). Calling
2269     * it directly will not have the expected results.
2270     *
2271     * @see elm_box_transition_new
2272     * @see elm_box_transition_free
2273     * @see elm_box_layout_set
2274     */
2275    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2276    /**
2277     * Create a new ::Elm_Box_Transition to animate the switch of layouts
2278     *
2279     * If you want to animate the change from one layout to another, you need
2280     * to set the layout function of the box to elm_box_layout_transition(),
2281     * passing as user data to it an instance of ::Elm_Box_Transition with the
2282     * necessary information to perform this animation. The free function to
2283     * set for the layout is elm_box_transition_free().
2284     *
2285     * The parameters to create an ::Elm_Box_Transition sum up to how long
2286     * will it be, in seconds, a layout function to describe the initial point,
2287     * another for the final position of the children and one function to be
2288     * called when the whole animation ends. This last function is useful to
2289     * set the definitive layout for the box, usually the same as the end
2290     * layout for the animation, but could be used to start another transition.
2291     *
2292     * @param start_layout The layout function that will be used to start the animation
2293     * @param start_layout_data The data to be passed the @p start_layout function
2294     * @param start_layout_free_data Function to free @p start_layout_data
2295     * @param end_layout The layout function that will be used to end the animation
2296     * @param end_layout_free_data The data to be passed the @p end_layout function
2297     * @param end_layout_free_data Function to free @p end_layout_data
2298     * @param transition_end_cb Callback function called when animation ends
2299     * @param transition_end_data Data to be passed to @p transition_end_cb
2300     * @return An instance of ::Elm_Box_Transition
2301     *
2302     * @see elm_box_transition_new
2303     * @see elm_box_layout_transition
2304     */
2305    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);
2306    /**
2307     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2308     *
2309     * This function is mostly useful as the @c free_data parameter in
2310     * elm_box_layout_set() when elm_box_layout_transition().
2311     *
2312     * @param data The Elm_Box_Transition instance to be freed.
2313     *
2314     * @see elm_box_transition_new
2315     * @see elm_box_layout_transition
2316     */
2317    EAPI void                elm_box_transition_free(void *data);
2318    /**
2319     * @}
2320     */
2321
2322    /* button */
2323    /**
2324     * @defgroup Button Button
2325     *
2326     * This is a push-button. Press it and run some function. It can contain
2327     * a simple label and icon object and it also has an autorepeat feature.
2328     *
2329     * This widgets emits the following signals:
2330     * @li "clicked": the user clicked the button (press/release).
2331     * @li "repeated": the user pressed the button without releasing it.
2332     * @li "unpressed": button was released after being pressed.
2333     * In all three cases, the @c event parameter of the callback will be
2334     * @c NULL.
2335     *
2336     * Also, defined in the default theme, the button has the following styles
2337     * available:
2338     * @li default: a normal button.
2339     * @li anchor: Like default, but the button fades away when the mouse is not
2340     * over it, leaving only the text or icon.
2341     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2342     * continuous look across its options.
2343     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2344     *
2345     * Follow through a complete example @ref button_example_01 "here".
2346     * @{
2347     */
2348    /**
2349     * Add a new button to the parent's canvas
2350     *
2351     * @param parent The parent object
2352     * @return The new object or NULL if it cannot be created
2353     */
2354    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2355    /**
2356     * Set the label used in the button
2357     *
2358     * The passed @p label can be NULL to clean any existing text in it and
2359     * leave the button as an icon only object.
2360     *
2361     * @param obj The button object
2362     * @param label The text will be written on the button
2363     */
2364    EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2365    /**
2366     * Get the label set for the button
2367     *
2368     * The string returned is an internal pointer and should not be freed or
2369     * altered. It will also become invalid when the button is destroyed.
2370     * The string returned, if not NULL, is a stringshare, so if you need to
2371     * keep it around even after the button is destroyed, you can use
2372     * eina_stringshare_ref().
2373     *
2374     * @param obj The button object
2375     * @return The text set to the label, or NULL if nothing is set
2376     */
2377    EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2378    /**
2379     * Set the icon used for the button
2380     *
2381     * Setting a new icon will delete any other that was previously set, making
2382     * any reference to them invalid. If you need to maintain the previous
2383     * object alive, unset it first with elm_button_icon_unset().
2384     *
2385     * @param obj The button object
2386     * @param icon The icon object for the button
2387     */
2388    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2389    /**
2390     * Get the icon used for the button
2391     *
2392     * Return the icon object which is set for this widget. If the button is
2393     * destroyed or another icon is set, the returned object will be deleted
2394     * and any reference to it will be invalid.
2395     *
2396     * @param obj The button object
2397     * @return The icon object that is being used
2398     *
2399     * @see elm_button_icon_unset()
2400     */
2401    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2402    /**
2403     * Remove the icon set without deleting it and return the object
2404     *
2405     * This function drops the reference the button holds of the icon object
2406     * and returns this last object. It is used in case you want to remove any
2407     * icon, or set another one, without deleting the actual object. The button
2408     * will be left without an icon set.
2409     *
2410     * @param obj The button object
2411     * @return The icon object that was being used
2412     */
2413    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2414    /**
2415     * Turn on/off the autorepeat event generated when the button is kept pressed
2416     *
2417     * When off, no autorepeat is performed and buttons emit a normal @c clicked
2418     * signal when they are clicked.
2419     *
2420     * When on, keeping a button pressed will continuously emit a @c repeated
2421     * signal until the button is released. The time it takes until it starts
2422     * emitting the signal is given by
2423     * elm_button_autorepeat_initial_timeout_set(), and the time between each
2424     * new emission by elm_button_autorepeat_gap_timeout_set().
2425     *
2426     * @param obj The button object
2427     * @param on  A bool to turn on/off the event
2428     */
2429    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
2430    /**
2431     * Get whether the autorepeat feature is enabled
2432     *
2433     * @param obj The button object
2434     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
2435     *
2436     * @see elm_button_autorepeat_set()
2437     */
2438    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2439    /**
2440     * Set the initial timeout before the autorepeat event is generated
2441     *
2442     * Sets the timeout, in seconds, since the button is pressed until the
2443     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
2444     * won't be any delay and the even will be fired the moment the button is
2445     * pressed.
2446     *
2447     * @param obj The button object
2448     * @param t   Timeout in seconds
2449     *
2450     * @see elm_button_autorepeat_set()
2451     * @see elm_button_autorepeat_gap_timeout_set()
2452     */
2453    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2454    /**
2455     * Get the initial timeout before the autorepeat event is generated
2456     *
2457     * @param obj The button object
2458     * @return Timeout in seconds
2459     *
2460     * @see elm_button_autorepeat_initial_timeout_set()
2461     */
2462    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2463    /**
2464     * Set the interval between each generated autorepeat event
2465     *
2466     * After the first @c repeated event is fired, all subsequent ones will
2467     * follow after a delay of @p t seconds for each.
2468     *
2469     * @param obj The button object
2470     * @param t   Interval in seconds
2471     *
2472     * @see elm_button_autorepeat_initial_timeout_set()
2473     */
2474    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
2475    /**
2476     * Get the interval between each generated autorepeat event
2477     *
2478     * @param obj The button object
2479     * @return Interval in seconds
2480     */
2481    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2482    /**
2483     * @}
2484     */
2485
2486    /* fileselector */
2487    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2488    EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2489    EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2490    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2491    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2492    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2493    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2494    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2495    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2496    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2497    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2498    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2499    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2500    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2501    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2502    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2503    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2504    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2505    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2506    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2507    /* available styles:
2508     * default
2509     * anchor
2510     * hoversel_vertical
2511     * hoversel_vertical_entry
2512     */
2513    /* smart callbacks called:
2514     * "file,chosen" - the user has selected a path, whose string pointer comes
2515                       as event info
2516     */
2517
2518    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2519    EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2520    EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2521    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2522    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2523    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2524    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2525    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2526    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2527    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2528    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2529    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2530    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2531    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2532    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2533    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2534    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2535    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2536    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
2537    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2538    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
2539    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2540
2541    /* scroller policy */
2542    typedef enum _Elm_Scroller_Policy
2543      {
2544         ELM_SCROLLER_POLICY_AUTO = 0,
2545         ELM_SCROLLER_POLICY_ON,
2546         ELM_SCROLLER_POLICY_OFF,
2547         ELM_SCROLLER_POLICY_LAST
2548      } Elm_Scroller_Policy;
2549
2550    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2551    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
2552    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2553    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2554    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
2555    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
2556    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);
2557    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
2558    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
2559    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);
2560    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2561    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2562    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2563    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2564    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2565    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);
2566    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
2567    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
2568    /* smart callbacks called:
2569     * "edge,left" - the left edge of the content has been reached
2570     * "edge,right" - the right edge of the content has been reached
2571     * "edge,top" - the top edge of the content has been reached
2572     * "edge,bottom" - the bottom edge of the content has been reached
2573     * "scroll" - the content has been scrolled (moved)
2574     * "scroll,anim,start" - scrolling animation has started
2575     * "scroll,anim,stop" - scrolling animation has stopped
2576     * "scroll,drag,start" - dragging the contents around has started
2577     * "scroll,drag,stop" - dragging the contents around has stopped
2578     */
2579
2580    /* label */
2581    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2582    EAPI void         elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2583    EAPI const char  *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2584    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2585    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2586    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
2587    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2588    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
2589    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2590    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
2591    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);
2592    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
2593    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);
2594    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
2595    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
2596    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2597    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
2598    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
2599    /* available styles:
2600     * default
2601     * marker
2602     */
2603    /* smart callbacks called:
2604     */
2605
2606    /* toggle */
2607    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2608    EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2609    EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2610    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
2611    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2612    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2613    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
2614    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
2615    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
2616    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2617    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
2618    /* smart callbacks called:
2619     * "changed" - Whenever the toggle value has been changed.  Is not called
2620     *             until the toggle is released by the cursor (assuming it has been triggered
2621     *             by the cursor in the first place).
2622     */
2623
2624    /* frame */
2625    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2626    EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label); EINA_ARG_NONNULL(1)
2627    EAPI const char  *elm_frame_label_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
2628    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1)
2629    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
2630    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj); EINA_ARG_NONNULL(1)
2631    /* available styles:
2632     * default
2633     * pad_small
2634     * pad_medium
2635     * pad_large
2636     * pad_huge
2637     * outdent_top
2638     * outdent_bottom
2639     */
2640    /* smart callbacks called:
2641     */
2642
2643    /* table */
2644    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2645    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2646    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2647    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2648    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2649    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2650    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2651    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2652    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2653    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
2654    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
2655    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
2656          
2657    /* gengrid */
2658    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
2659    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
2660    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
2661    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
2662    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
2663    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
2664    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj);
2665
2666    struct _Elm_Gengrid_Item_Class
2667      {
2668         const char             *item_style;
2669         struct _Elm_Gengrid_Item_Class_Func
2670           {
2671              GridItemLabelGetFunc  label_get;
2672              GridItemIconGetFunc   icon_get;
2673              GridItemStateGetFunc  state_get;
2674              GridItemDelFunc       del;
2675           } func;
2676      };
2677
2678    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2679    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2680    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
2681    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
2682    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
2683
2684    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
2685    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2686    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
2687    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2688    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
2689    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2690    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
2691    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2692    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
2693    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
2694    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
2695    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
2696    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
2697    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
2698    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2699
2700    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2701    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2702
2703    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2704    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2705    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2706    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2707    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2708    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2709    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
2710    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2711    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
2712    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
2713    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
2714    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2715    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2716    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2717    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2718    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2719    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2720
2721    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
2722    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);
2723    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2724    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2725    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2726    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
2727    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2728    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2729    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
2730    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2731    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
2732    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
2733
2734    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2735    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2736    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2737
2738    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);
2739    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);
2740    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);
2741    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);
2742    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);
2743    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);
2744    /* smart callbacks called:
2745     *
2746     * selected - User has selected an item.
2747     * unselected - User has unselected an item.
2748     * clicked,double - User has double-clicked or pressed enter on an item.
2749     * realized - An evas object for an item was built.
2750     * unrealized - An evas object for an item was deleted.
2751     * changed - An item has been added, removed, resized or moved,
2752     * or gengrid has been resized or horizontal property has been changed.
2753     * scroll - the content has been scrolled (moved).
2754     * "scroll,drag,start" - dragging the contents around has started.
2755     * "scroll,drat,stop" - dragging the contents around has stopped.
2756     * drag - Gengrid is being dragged.
2757     * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
2758     * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
2759     * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
2760     * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
2761     * "drag,stop" - Gengrid is not being dragged.
2762     */
2763
2764    /* clock */
2765    typedef enum _Elm_Clock_Digedit
2766      {
2767         ELM_CLOCK_NONE         = 0,
2768         ELM_CLOCK_HOUR_DECIMAL = 1 << 0,
2769         ELM_CLOCK_HOUR_UNIT    = 1 << 1,
2770         ELM_CLOCK_MIN_DECIMAL  = 1 << 2,
2771         ELM_CLOCK_MIN_UNIT     = 1 << 3,
2772         ELM_CLOCK_SEC_DECIMAL  = 1 << 4,
2773         ELM_CLOCK_SEC_UNIT     = 1 << 5,
2774         ELM_CLOCK_ALL          = (1 << 6) - 1
2775      } Elm_Clock_Digedit;
2776
2777    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2778    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
2779    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
2780    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
2781    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2782    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
2783    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2784    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
2785    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2786    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
2787    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2788    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
2789    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2790    /* smart callbacks called:
2791     * "changed" - the user changed the time
2792     */
2793
2794    /* layout */
2795    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2796    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2797    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
2798    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
2799    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2800    EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2801    EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
2802    EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
2803    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
2804    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
2805    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
2806    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
2807    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
2808    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
2809    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);
2810    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
2811    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
2812    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2813    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
2814    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
2815    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
2816    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2817    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2818    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
2819    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2820    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);
2821    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
2822 /**
2823  * @def elm_layout_icon_set
2824  * Convienience macro to set the icon object in a layout that follows the
2825  * Elementary naming convention for its parts.
2826  *
2827  * @ingroup Layout
2828  */
2829 #define elm_layout_icon_set(_ly, _obj) \
2830   do { \
2831     const char *sig; \
2832     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
2833     if ((_obj)) sig = "elm,state,icon,visible"; \
2834     else sig = "elm,state,icon,hidden"; \
2835     elm_object_signal_emit((_ly), sig, "elm"); \
2836   } while (0)
2837
2838 /**
2839  * @def elm_layout_icon_get
2840  * Convienience macro to get the icon object from a layout that follows the
2841  * Elementary naming convention for its parts.
2842  *
2843  * @ingroup Layout
2844  */
2845 #define elm_layout_icon_get(_ly) \
2846   elm_layout_content_get((_ly), "elm.swallow.icon")
2847
2848 /**
2849  * @def elm_layout_end_set
2850  * Convienience macro to set the end object in a layout that follows the
2851  * Elementary naming convention for its parts.
2852  *
2853  * @ingroup Layout
2854  */
2855 #define elm_layout_end_set(_ly, _obj) \
2856   do { \
2857     const char *sig; \
2858     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
2859     if ((_obj)) sig = "elm,state,end,visible"; \
2860     else sig = "elm,state,end,hidden"; \
2861     elm_object_signal_emit((_ly), sig, "elm"); \
2862   } while (0)
2863
2864 /**
2865  * @def elm_layout_end_get
2866  * Convienience macro to get the end object in a layout that follows the
2867  * Elementary naming convention for its parts.
2868  *
2869  * @ingroup Layout
2870  */
2871 #define elm_layout_end_get(_ly) \
2872   elm_layout_content_get((_ly), "elm.swallow.end")
2873
2874 /**
2875  * @def elm_layout_label_set
2876  * Convienience macro to set the label in a layout that follows the
2877  * Elementary naming convention for its parts.
2878  *
2879  * @ingroup Layout
2880  */
2881 #define elm_layout_label_set(_ly, _txt) \
2882   elm_layout_text_set((_ly), "elm.text", (_txt))
2883
2884 /**
2885  * @def elm_layout_label_get
2886  * Convienience macro to get the label in a layout that follows the
2887  * Elementary naming convention for its parts.
2888  *
2889  * @ingroup Layout
2890  */
2891 #define elm_layout_label_get(_ly) \
2892   elm_layout_text_get((_ly), "elm.text")
2893
2894    /* smart callbacks called:
2895     */
2896
2897    /* notify */
2898    typedef enum _Elm_Notify_Orient
2899      {
2900         ELM_NOTIFY_ORIENT_TOP,
2901         ELM_NOTIFY_ORIENT_CENTER,
2902         ELM_NOTIFY_ORIENT_BOTTOM,
2903         ELM_NOTIFY_ORIENT_LEFT,
2904         ELM_NOTIFY_ORIENT_RIGHT,
2905         ELM_NOTIFY_ORIENT_TOP_LEFT,
2906         ELM_NOTIFY_ORIENT_TOP_RIGHT,
2907         ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
2908         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
2909         ELM_NOTIFY_ORIENT_LAST
2910      } Elm_Notify_Orient;
2911    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2912    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2913    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2914    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2915    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2916    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2917    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
2918    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2919    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
2920    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2921    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
2922    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2923    /* smart callbacks called:
2924     * "timeout" - when timeout happens on notify and it's hidden
2925     * "block,clicked" - when it's hidden by a click outside of the notify's view
2926     */
2927
2928    /* hover */
2929    typedef enum _Elm_Hover_Axis
2930      {
2931         ELM_HOVER_AXIS_NONE,
2932         ELM_HOVER_AXIS_HORIZONTAL,
2933         ELM_HOVER_AXIS_VERTICAL,
2934         ELM_HOVER_AXIS_BOTH
2935      } Elm_Hover_Axis;
2936    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2937    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
2938    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2939    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
2940    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2941    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
2942    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2943    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
2944    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
2945    /* available styles:
2946     * default
2947     * popout
2948     * menu
2949     * hoversel_vertical
2950     */
2951    /* smart callbacks called:
2952     * "clicked" - the user clicked the empty space in the hover to dismiss
2953     * "smart,changed" - a content object placed under the "smart"
2954     *                   policy was replaced to a new slot direction.
2955     */
2956
2957    /* entry */
2958    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
2959    struct _Elm_Entry_Anchor_Info
2960      {
2961         const char *name;
2962         int         button;
2963         Evas_Coord  x, y, w, h;
2964      };
2965    typedef enum _Elm_Icon_Type
2966      {
2967         ELM_ICON_NONE,
2968         ELM_ICON_FILE,
2969         ELM_ICON_STANDARD
2970      } Elm_Icon_Type;
2971    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
2972
2973    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2974    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
2975    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2976    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
2977    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2978    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
2979    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2980    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
2981    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2982    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2983    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
2984    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
2985    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
2986    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2987    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
2988    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2989    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
2990    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
2991    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
2992    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
2993    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2994    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2995    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2996    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2997    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
2998    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
2999    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3000    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3001    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3002    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);
3003    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
3004    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3005    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
3006    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
3007    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
3008    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3009    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);
3010    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3011    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3012    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);
3013    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);
3014    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);
3015    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);
3016    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);
3017    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);
3018    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3019    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
3020    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
3021    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
3022    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
3023    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
3024    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3025    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
3026    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3027    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
3028    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
3029    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
3030    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
3031    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
3032    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
3033    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
3034    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
3035    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
3036    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
3037    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
3038    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
3039    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
3040          
3041    /* pre-made filters for entries */
3042    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
3043    struct _Elm_Entry_Filter_Limit_Size
3044      {
3045         int max_char_count;
3046         int max_byte_count;
3047      };
3048    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
3049    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
3050    struct _Elm_Entry_Filter_Accept_Set
3051      {
3052         const char *accepted;
3053         const char *rejected;
3054      };
3055    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
3056    /* smart callbacks called:
3057     * "changed" - the text content changed
3058     * "selection,start" - the user started selecting text
3059     * "selection,changed" - the user modified the selection size/location
3060     * "selection,cleared" - the user cleared the selection
3061     * "selection,paste" - the user requested a paste of text
3062     * "selection,copy" - the user copied the text
3063     * "selection,cut" - the user cut the text
3064     * "cursor,changed" - the cursor changed position
3065     * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
3066     * "activated" - when the enter key is pressed (useful for single line)
3067     * "press" - when finger/mouse is pressed down
3068     * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
3069     * "clicked,double" - when finger/mouse is double-pressed
3070     * "longpressed" - the entry has been longpressed
3071     * "focused" - the entry has received keyboard focus
3072     * "unfocused" - keyboard focus is gone
3073     */
3074
3075    /* composite widgets - these basically put together basic widgets above
3076     * in convenient packages that do more than basic stuff */
3077
3078    /* anchorview */
3079    /**
3080     * @defgroup Anchorview Anchorview
3081     *
3082     * Anchorview is for displaying text that contains markup with anchors
3083     * like <c>\<a href=1234\>something\</\></c> in it.
3084     *
3085     * Besides being styled differently, the anchorview widget provides the
3086     * necessary functionality so that clicking on these anchors brings up a
3087     * popup with user defined content such as "call", "add to contacts" or
3088     * "open web page". This popup is provided using the @ref Hover widget.
3089     *
3090     * This widget is very similar to @ref Anchorblock, so refer to that
3091     * widget for an example. The only difference Anchorview has is that the
3092     * widget is already provided with scrolling functionality, so if the
3093     * text set to it is too large to fit in the given space, it will scroll,
3094     * whereas the @ref Anchorblock widget will keep growing to ensure all the
3095     * text can be displayed.
3096     *
3097     * This widget emits the following signals:
3098     * @li "anchor,clicked": will be called when an anchor is clicked. The
3099     * @p event_info parameter on the callback will be a pointer of type
3100     * ::Elm_Entry_Anchorview_Info.
3101     *
3102     * See @ref Anchorblock for an example on how to use both of them.
3103     *
3104     * @see Anchorblock
3105     * @see Entry
3106     * @see Hover
3107     *
3108     * @{
3109     */
3110    /**
3111     * @typedef Elm_Entry_Anchorview_Info
3112     *
3113     * The info sent in the callback for "anchor,clicked" signals emitted by
3114     * the Anchorview widget.
3115     */
3116    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
3117    /**
3118     * @struct _Elm_Entry_Anchorview_Info
3119     *
3120     * The info sent in the callback for "anchor,clicked" signals emitted by
3121     * the Anchorview widget.
3122     */
3123    struct _Elm_Entry_Anchorview_Info
3124      {
3125         const char     *name; /**< Name of the anchor, as indicated in its href
3126                                    attribute */
3127         int             button; /**< The mouse button used to click on it */
3128         Evas_Object    *hover; /**< The hover object to use for the popup */
3129         struct {
3130              Evas_Coord    x, y, w, h;
3131         } anchor, /**< Geometry selection of text used as anchor */
3132           hover_parent; /**< Geometry of the object used as parent by the
3133                              hover */
3134         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
3135                                              for content on the left side of
3136                                              the hover. Before calling the
3137                                              callback, the widget will make the
3138                                              necessary calculations to check
3139                                              which sides are fit to be set with
3140                                              content, based on the position the
3141                                              hover is activated and its distance
3142                                              to the edges of its parent object
3143                                              */
3144         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
3145                                               the right side of the hover.
3146                                               See @ref hover_left */
3147         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
3148                                             of the hover. See @ref hover_left */
3149         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
3150                                                below the hover. See @ref
3151                                                hover_left */
3152      };
3153    /**
3154     * Add a new Anchorview object
3155     *
3156     * @param parent The parent object
3157     * @return The new object or NULL if it cannot be created
3158     */
3159    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3160    /**
3161     * Set the text to show in the anchorview
3162     *
3163     * Sets the text of the anchorview to @p text. This text can include markup
3164     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
3165     * text that will be specially styled and react to click events, ended with
3166     * either of \</a\> or \</\>. When clicked, the anchor will emit an
3167     * "anchor,clicked" signal that you can attach a callback to with
3168     * evas_object_smart_callback_add(). The name of the anchor given in the
3169     * event info struct will be the one set in the href attribute, in this
3170     * case, anchorname.
3171     *
3172     * Other markup can be used to style the text in different ways, but it's
3173     * up to the style defined in the theme which tags do what.
3174     */
3175    EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
3176    /**
3177     * Get the markup text set for the anchorview
3178     *
3179     * Retrieves the text set on the anchorview, with markup tags included.
3180     *
3181     * @param obj The anchorview object
3182     * @return The markup text set or @c NULL if nothing was set or an error
3183     * occurred
3184     */
3185    EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3186    /**
3187     * Set the parent of the hover popup
3188     *
3189     * Sets the parent object to use by the hover created by the anchorview
3190     * when an anchor is clicked. See @ref Hover for more details on this.
3191     * If no parent is set, the same anchorview object will be used.
3192     *
3193     * @param obj The anchorview object
3194     * @param parent The object to use as parent for the hover
3195     */
3196    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3197    /**
3198     * Get the parent of the hover popup
3199     *
3200     * Get the object used as parent for the hover created by the anchorview
3201     * widget. See @ref Hover for more details on this.
3202     *
3203     * @param obj The anchorview object
3204     * @return The object used as parent for the hover, NULL if none is set.
3205     */
3206    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3207    /**
3208     * Set the style that the hover should use
3209     *
3210     * When creating the popup hover, anchorview will request that it's
3211     * themed according to @p style.
3212     *
3213     * @param obj The anchorview object
3214     * @param style The style to use for the underlying hover
3215     *
3216     * @see elm_object_style_set()
3217     */
3218    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3219    /**
3220     * Get the style that the hover should use
3221     *
3222     * Get the style the hover created by anchorview will use.
3223     *
3224     * @param obj The anchorview object
3225     * @return The style to use by the hover. NULL means the default is used.
3226     *
3227     * @see elm_object_style_set()
3228     */
3229    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3230    /**
3231     * Ends the hover popup in the anchorview
3232     *
3233     * When an anchor is clicked, the anchorview widget will create a hover
3234     * object to use as a popup with user provided content. This function
3235     * terminates this popup, returning the anchorview to its normal state.
3236     *
3237     * @param obj The anchorview object
3238     */
3239    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3240    /**
3241     * Set bouncing behaviour when the scrolled content reaches an edge
3242     *
3243     * Tell the internal scroller object whether it should bounce or not
3244     * when it reaches the respective edges for each axis.
3245     *
3246     * @param obj The anchorview object
3247     * @param h_bounce Whether to bounce or not in the horizontal axis
3248     * @param v_bounce Whether to bounce or not in the vertical axis
3249     *
3250     * @see elm_scroller_bounce_set()
3251     */
3252    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3253    /**
3254     * Get the set bouncing behaviour of the internal scroller
3255     *
3256     * Get whether the internal scroller should bounce when the edge of each
3257     * axis is reached scrolling.
3258     *
3259     * @param obj The anchorview object
3260     * @param h_bounce Pointer where to store the bounce state of the horizontal
3261     *                 axis
3262     * @param v_bounce Pointer where to store the bounce state of the vertical
3263     *                 axis
3264     *
3265     * @see elm_scroller_bounce_get()
3266     */
3267    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3268    /**
3269     * Appends a custom item provider to the given anchorview
3270     *
3271     * Appends the given function to the list of items providers. This list is
3272     * called, one function at a time, with the given @p data pointer, the
3273     * anchorview object and, in the @p item parameter, the item name as
3274     * referenced in its href string. Following functions in the list will be
3275     * called in order until one of them returns something different to NULL,
3276     * which should be an Evas_Object which will be used in place of the item
3277     * element.
3278     *
3279     * Items in the markup text take the form \<item relsize=16x16 vsize=full
3280     * href=item/name\>\</item\>
3281     *
3282     * @param obj The anchorview object
3283     * @param func The function to add to the list of providers
3284     * @param data User data that will be passed to the callback function
3285     *
3286     * @see elm_entry_item_provider_append()
3287     */
3288    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);
3289    /**
3290     * Prepend a custom item provider to the given anchorview
3291     *
3292     * Like elm_anchorview_item_provider_append(), but it adds the function
3293     * @p func to the beginning of the list, instead of the end.
3294     *
3295     * @param obj The anchorview object
3296     * @param func The function to add to the list of providers
3297     * @param data User data that will be passed to the callback function
3298     */
3299    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);
3300    /**
3301     * Remove a custom item provider from the list of the given anchorview
3302     *
3303     * Removes the function and data pairing that matches @p func and @p data.
3304     * That is, unless the same function and same user data are given, the
3305     * function will not be removed from the list. This allows us to add the
3306     * same callback several times, with different @p data pointers and be
3307     * able to remove them later without conflicts.
3308     *
3309     * @param obj The anchorview object
3310     * @param func The function to remove from the list
3311     * @param data The data matching the function to remove from the list
3312     */
3313    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);
3314    /**
3315     * @}
3316     */
3317
3318    /* anchorblock */
3319    /**
3320     * @defgroup Anchorblock Anchorblock
3321     *
3322     * Anchorblock is for displaying text that contains markup with anchors
3323     * like <c>\<a href=1234\>something\</\></c> in it.
3324     *
3325     * Besides being styled differently, the anchorblock widget provides the
3326     * necessary functionality so that clicking on these anchors brings up a
3327     * popup with user defined content such as "call", "add to contacts" or
3328     * "open web page". This popup is provided using the @ref Hover widget.
3329     *
3330     * This widget emits the following signals:
3331     * @li "anchor,clicked": will be called when an anchor is clicked. The
3332     * @p event_info parameter on the callback will be a pointer of type
3333     * ::Elm_Entry_Anchorblock_Info.
3334     *
3335     * @see Anchorview
3336     * @see Entry
3337     * @see Hover
3338     *
3339     * Since examples are usually better than plain words, we might as well
3340     * try one. This exampel will show both Anchorblock and @ref Anchorview,
3341     * since both are very similar and it's easier to show them once and side
3342     * by side, so the difference is more clear.
3343     *
3344     * We'll show the relevant snippets of the code here, but the full example
3345     * can be found here... sorry, @ref anchorblock_example_01.c "here".
3346     *
3347     * As for the actual example, it's just a simple window with an anchorblock
3348     * and an anchorview, both containing the same text. After including
3349     * Elementary.h and declaring some functions we'll need, we jump to our
3350     * elm_main (see ELM_MAIN) and create our window.
3351     * @dontinclude anchorblock_example_01.c
3352     * @skip int
3353     * @until const char
3354     * @until ;
3355     *
3356     * With the needed variables declared, we'll create the window and a box to
3357     * hold our widgets, but we don't need to go through that here.
3358     *
3359     * In order to make clear where the anchorblock ends and the anchorview
3360     * begins, they'll be each inside a @ref Frame. After creating the frame,
3361     * the anchorblock follows.
3362     * @skip elm_frame_add
3363     * @until elm_frame_content_set
3364     *
3365     * Nothing out of the ordinary there. What's worth mentioning is the call
3366     * to elm_anchorblock_hover_parent_set(). We are telling our widget that
3367     * when an anchor is clicked, the hover for the popup will cover the entire
3368     * window. This affects the area that will be obscured by the hover and
3369     * where clicking will dismiss it, as well as the calculations it does to
3370     * inform the best locations where to insert the popups content.
3371     * Other than that, the code is pretty standard. We also need to set our
3372     * callback for when an anchor is clicked, since it's our task to populate
3373     * the popup. There's no default for it.
3374     *
3375     * The anchorview is no different, we only change a few things so it looks
3376     * different.
3377     * @until elm_frame_content_set
3378     *
3379     * Then we run, so stuff works and close our main function in the usual way.
3380     * @until ELM_MAIN
3381     *
3382     * Now, a little note. Normally you would use either one of anchorblock or
3383     * anchorview, set your one callback to clicks and do your stuff in there.
3384     * In this example, however, there are a few tricks to make it easier to
3385     * show both widgets in one go (and to save me some typing). So we have
3386     * two callbacks, one per widget, that will call a common function to do
3387     * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
3388     * anchorview too, since both are equal, and passing a callback to use
3389     * for our buttons to end the hover, because each widget has a different
3390     * function for it.
3391     * @until _anchorview_clicked_cb
3392     * @until }
3393     *
3394     * The meat of our popup is in the following function. We check what kind
3395     * of menu we need to show, based on the name set to the anchor in the
3396     * markup text. If there's no type (something went wrong, no valid contact
3397     * in the address list) we are just putting a button that does nothing, but
3398     * it's perfectly reasonable to just end the hover and call it quits.
3399     *
3400     * Our popup will consist of one main button in the middle of our hover,
3401     * and possibly a secondary button and a list of other options. We'll create
3402     * first our main button and check what kind of popup we need afterwards.
3403     * @skip static void
3404     * @skip static void
3405     * @until eina_stringshare_add
3406     * @until }
3407     *
3408     * Each button has two callbacks, one is our hack to close the hover
3409     * properly based on which widget it belongs to, the other a simple
3410     * printf that will show the action with the anchors own data. This is
3411     * not how you would usually do it. Instead, the common case is to have
3412     * one callback for the button that will know which function to call to end
3413     * things, but since we are doing it this way it's worth noting that
3414     * smart callbacks will be called in reverse in respect to the order they
3415     * were added, and since our @c btn_end_cb will close the hover, and thus
3416     * delete our buttons, the other callback wouldn't be called if we had
3417     * added it before.
3418     *
3419     * After our telephone popup, there are a few others that are practically
3420     * the same, so they won't be shown here.
3421     *
3422     * Once we are done with that, it's time to place our actions into our
3423     * hover. Main button goes in the middle without much questioning, and then
3424     * we see if we have a secondary button and a box of extra options.
3425     * Because I said so, secondary button goes on either side and box of
3426     * options either on top or below the main one, but to choose which
3427     * exactly, we use the hints our callback info has, which saves us from
3428     * having to do the math and see which side has more space available, with
3429     * a little special case where we delete our extra stuff if there's nowhere
3430     * to place it.
3431     * @skip url:
3432     * @skip }
3433     * @skip evas_object_smart
3434     * @until evas_object_del(box)
3435     * @until }
3436     * @until }
3437     */
3438    /**
3439     * @example anchorblock_example_01.c
3440     */
3441    /**
3442     * @addtogroup Anchorblock
3443     * @{
3444     */
3445    /**
3446     * @typedef Elm_Entry_Anchorblock_Info
3447     *
3448     * The info sent in the callback for "anchor,clicked" signals emitted by
3449     * the Anchorblock widget.
3450     */
3451    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
3452    /**
3453     * @struct _Elm_Entry_Anchorblock_Info
3454     *
3455     * The info sent in the callback for "anchor,clicked" signals emitted by
3456     * the Anchorblock widget.
3457     */
3458    struct _Elm_Entry_Anchorblock_Info
3459      {
3460         const char     *name; /**< Name of the anchor, as indicated in its href
3461                                    attribute */
3462         int             button; /**< The mouse button used to click on it */
3463         Evas_Object    *hover; /**< The hover object to use for the popup */
3464         struct {
3465              Evas_Coord    x, y, w, h;
3466         } anchor, /**< Geometry selection of text used as anchor */
3467           hover_parent; /**< Geometry of the object used as parent by the
3468                              hover */
3469         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
3470                                              for content on the left side of
3471                                              the hover. Before calling the
3472                                              callback, the widget will make the
3473                                              necessary calculations to check
3474                                              which sides are fit to be set with
3475                                              content, based on the position the
3476                                              hover is activated and its distance
3477                                              to the edges of its parent object
3478                                              */
3479         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
3480                                               the right side of the hover.
3481                                               See @ref hover_left */
3482         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
3483                                             of the hover. See @ref hover_left */
3484         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
3485                                                below the hover. See @ref
3486                                                hover_left */
3487      };
3488    /**
3489     * Add a new Anchorblock object
3490     *
3491     * @param parent The parent object
3492     * @return The new object or NULL if it cannot be created
3493     */
3494    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3495    /**
3496     * Set the text to show in the anchorblock
3497     *
3498     * Sets the text of the anchorblock to @p text. This text can include markup
3499     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
3500     * of text that will be specially styled and react to click events, ended
3501     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
3502     * "anchor,clicked" signal that you can attach a callback to with
3503     * evas_object_smart_callback_add(). The name of the anchor given in the
3504     * event info struct will be the one set in the href attribute, in this
3505     * case, anchorname.
3506     *
3507     * Other markup can be used to style the text in different ways, but it's
3508     * up to the style defined in the theme which tags do what.
3509     */
3510    EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
3511    /**
3512     * Get the markup text set for the anchorblock
3513     *
3514     * Retrieves the text set on the anchorblock, with markup tags included.
3515     *
3516     * @param obj The anchorblock object
3517     * @return The markup text set or @c NULL if nothing was set or an error
3518     * occurred
3519     */
3520    EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3521    /**
3522     * Set the parent of the hover popup
3523     *
3524     * Sets the parent object to use by the hover created by the anchorblock
3525     * when an anchor is clicked. See @ref Hover for more details on this.
3526     *
3527     * @param obj The anchorblock object
3528     * @param parent The object to use as parent for the hover
3529     */
3530    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3531    /**
3532     * Get the parent of the hover popup
3533     *
3534     * Get the object used as parent for the hover created by the anchorblock
3535     * widget. See @ref Hover for more details on this.
3536     * If no parent is set, the same anchorblock object will be used.
3537     *
3538     * @param obj The anchorblock object
3539     * @return The object used as parent for the hover, NULL if none is set.
3540     */
3541    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3542    /**
3543     * Set the style that the hover should use
3544     *
3545     * When creating the popup hover, anchorblock will request that it's
3546     * themed according to @p style.
3547     *
3548     * @param obj The anchorblock object
3549     * @param style The style to use for the underlying hover
3550     *
3551     * @see elm_object_style_set()
3552     */
3553    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3554    /**
3555     * Get the style that the hover should use
3556     *
3557     * Get the style the hover created by anchorblock will use.
3558     *
3559     * @param obj The anchorblock object
3560     * @return The style to use by the hover. NULL means the default is used.
3561     *
3562     * @see elm_object_style_set()
3563     */
3564    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3565    /**
3566     * Ends the hover popup in the anchorblock
3567     *
3568     * When an anchor is clicked, the anchorblock widget will create a hover
3569     * object to use as a popup with user provided content. This function
3570     * terminates this popup, returning the anchorblock to its normal state.
3571     *
3572     * @param obj The anchorblock object
3573     */
3574    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3575    /**
3576     * Appends a custom item provider to the given anchorblock
3577     *
3578     * Appends the given function to the list of items providers. This list is
3579     * called, one function at a time, with the given @p data pointer, the
3580     * anchorblock object and, in the @p item parameter, the item name as
3581     * referenced in its href string. Following functions in the list will be
3582     * called in order until one of them returns something different to NULL,
3583     * which should be an Evas_Object which will be used in place of the item
3584     * element.
3585     *
3586     * Items in the markup text take the form \<item relsize=16x16 vsize=full
3587     * href=item/name\>\</item\>
3588     *
3589     * @param obj The anchorblock object
3590     * @param func The function to add to the list of providers
3591     * @param data User data that will be passed to the callback function
3592     *
3593     * @see elm_entry_item_provider_append()
3594     */
3595    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);
3596    /**
3597     * Prepend a custom item provider to the given anchorblock
3598     *
3599     * Like elm_anchorblock_item_provider_append(), but it adds the function
3600     * @p func to the beginning of the list, instead of the end.
3601     *
3602     * @param obj The anchorblock object
3603     * @param func The function to add to the list of providers
3604     * @param data User data that will be passed to the callback function
3605     */
3606    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);
3607    /**
3608     * Remove a custom item provider from the list of the given anchorblock
3609     *
3610     * Removes the function and data pairing that matches @p func and @p data.
3611     * That is, unless the same function and same user data are given, the
3612     * function will not be removed from the list. This allows us to add the
3613     * same callback several times, with different @p data pointers and be
3614     * able to remove them later without conflicts.
3615     *
3616     * @param obj The anchorblock object
3617     * @param func The function to remove from the list
3618     * @param data The data matching the function to remove from the list
3619     */
3620    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);
3621    /**
3622     * @}
3623     */
3624
3625    /* bubble */
3626    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3627    EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3628    EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3629    EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
3630    EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3631
3632    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3633    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3634    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3635    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3636    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3637    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3638    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
3639    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3640    /* smart callbacks called:
3641     * "clicked" - the user clicked the bubble
3642     */
3643
3644    /* photo */
3645    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3646    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
3647    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3648    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
3649    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3650    /* smart callbacks called:
3651     * "clicked" - the user clicked the icon
3652     * "drag,start" - Someone started dragging the image out of the object
3653     * "drag,end" - Dragged item was dropped (somewhere)
3654     */
3655
3656    /* thumb */
3657    typedef enum _Elm_Thumb_Animation_Setting
3658      {
3659         ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
3660         ELM_THUMB_ANIMATION_LOOP,      /* Keep playing animation until stop is requested */
3661         ELM_THUMB_ANIMATION_STOP,
3662         ELM_THUMB_ANIMATION_LAST
3663      } Elm_Thumb_Animation_Setting;
3664
3665    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3666    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
3667    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
3668    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
3669    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
3670    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
3671    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3672    EAPI void                        *elm_thumb_ethumb_client_get(void);
3673    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
3674    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3675    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3676    /* available styles:
3677     * default
3678     * noframe
3679     */
3680    /* smart callbacks called:
3681     * "clicked" - This is called when a user has clicked the thumb without dragging around.
3682     * "clicked,double" - This is called when a user has double-clicked the thumb.
3683     * "press" - This is called when a user has pressed down the thumb.
3684     * "generate,start" - The thumbnail generation started.
3685     * "generate,stop" - The generation process stopped.
3686     * "generate,error" - The generation failed.
3687     * "load,error" - The thumbnail image loading failed.
3688     */
3689
3690    /* hoversel */
3691    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3692    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3693    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3694    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3695    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3696    EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3697    EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3698    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3699    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3700    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3701    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
3702    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
3703    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3704    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3705    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3706    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);
3707    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
3708    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3709    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
3710    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
3711    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);
3712    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);
3713    /* smart callbacks called:
3714     * "clicked" - the user clicked the hoversel button and popped up the sel
3715     * "selected" - an item in the hoversel list is selected
3716     * "dismissed" - the hover is dismissed
3717     */
3718
3719    /* toolbar */
3720    typedef enum _Elm_Toolbar_Shrink_Mode
3721      {
3722         ELM_TOOLBAR_SHRINK_NONE,   /**< set toolbar minimun size to fit all the items */
3723         ELM_TOOLBAR_SHRINK_HIDE,   /**< hide excess items */
3724         ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
3725         ELM_TOOLBAR_SHRINK_MENU    /**< inserts a button to pop up a menu with excess items */
3726      } Elm_Toolbar_Shrink_Mode;
3727
3728    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
3729    typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
3730
3731    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3732    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
3733    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3734    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3735    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3736    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3737    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3738    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);
3739    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);
3740    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);
3741    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);
3742    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3743    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3744    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3745    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3746    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3747    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
3748    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3749    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3750    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3751    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
3752    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3753    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
3754    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3755    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3756    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3757    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3758    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
3759    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3760    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3761    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3762    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3763    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
3764    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3765    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
3766    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3767    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3768    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3769    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3770    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3771    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3772    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3773    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
3774    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3775    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
3776    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3777    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);
3778    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
3779    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
3780    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3781    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3782    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3783    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
3784    EAPI void                    elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
3785    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);
3786    EAPI void                    elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3787    EAPI void                    elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
3788    EAPI const char             *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3789    EAPI void                    elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3790    EAPI const char             *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3791    EAPI void                    elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3792    EAPI void                    elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
3793    EAPI const char             *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3794    EAPI void                    elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3795    EAPI Eina_Bool               elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
3796    /* smart callbacks called:
3797     * "clicked" - when the user clicks on a toolbar item and becomes selected
3798     */
3799    /* available styles:
3800     * default
3801     * transparent (no background or shadow, just show the provided content)
3802     */
3803
3804    /* tooltip */
3805    EAPI double       elm_tooltip_delay_get(void);
3806    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
3807    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
3808    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
3809    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
3810    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);
3811    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3812    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3813    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3814    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
3815    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3816    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3817    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3818    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3819    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3820    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3821
3822    /* cursors */
3823    EAPI int          elm_cursor_engine_only_get(void);
3824    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
3825
3826    /* menu */
3827    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
3828    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3829    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3830    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3831    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
3832    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
3833    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3834    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
3835    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);
3836    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
3837    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3838    EAPI void               elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
3839    EAPI const char        *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3840    EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3841    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3842    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3843    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3844    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3845    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
3846    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3847    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3848    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3849    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
3850    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
3851    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
3852    EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
3853    EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
3854    EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
3855    EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
3856    EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
3857
3858    /* smart callbacks called:
3859     * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
3860     */
3861
3862    /* list */
3863    typedef enum _Elm_List_Mode
3864      {
3865         ELM_LIST_COMPRESS = 0,
3866         ELM_LIST_SCROLL,
3867         ELM_LIST_LIMIT,
3868         ELM_LIST_EXPAND,
3869         ELM_LIST_LAST
3870      } Elm_List_Mode;
3871    typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
3872    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3873    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);
3874    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);
3875    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);
3876    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);
3877    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);
3878    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3879    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
3880    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3881    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3882    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
3883    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3884    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3885    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3886    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3887    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3888    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3889    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3890    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3891    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
3892    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
3893    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3894    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3895    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
3896    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
3897    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
3898    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
3899    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3900    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3901    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
3902    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3903    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
3904    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3905    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3906    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
3907    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
3908    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
3909    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
3910    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);
3911    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
3912    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
3913    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3914    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3915    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3916    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
3917    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
3918    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3919    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3920    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
3921    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3922    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
3923    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3924    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3925    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3926    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);
3927    /* smart callbacks called:
3928     * "clicked,double" - when the user double-clicked an item
3929     * "selected" - when the user selected an item
3930     * "unselected" - when the user selected an item
3931     * "longpressed" - an item in the hoversel list is long-pressed
3932     * "scroll,edge,top" - the list is scrolled until the top edge
3933     * "scroll,edge,bottom" - the list is scrolled until the bottom edge
3934     * "scroll,edge,left" - the list is scrolled until the left edge
3935     * "scroll,edge,right" - the list is scrolled until the right edge
3936     */
3937
3938    /* slider */
3939    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3940    EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3941    EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3942    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3943    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3944    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3945    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
3946    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3947    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3948    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
3949    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3950    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
3951    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3952    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
3953    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3954    EAPI void               elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val)) EINA_ARG_NONNULL(1);
3955    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3956    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3957    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
3958    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
3959    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
3960    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
3962    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3963    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
3964    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3965    /* smart callbacks called:
3966     * "changed" - Whenever the slider value is changed by the user.
3967     * "slider,drag,start" - dragging the slider indicator around has started
3968     * "slider,drag,stop" - dragging the slider indicator around has stopped
3969     * "delay,changed" - A short time after the value is changed by the user.
3970     *                   This will be called only when the user stops dragging for a very short
3971     *                   period or when they release their finger/mouse, so it avoids possibly
3972     *                   expensive reactions to the value change.
3973     */
3974
3975    /**
3976     * @addtogroup Actionslider Actionslider
3977     *
3978     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
3979     * properties. The indicator is the element the user drags to choose a label.
3980     * When the position is set with magnet, when released the indicator will be
3981     * moved to it if it's nearest the magnetized position.
3982     *
3983     * @note By default all positions are set as enabled.
3984     *
3985     * Signals that you can add callbacks for are:
3986     *
3987     * "selected" - when user selects an enabled position (the label is passed
3988     *              as event info)".
3989     * @n
3990     * "pos_changed" - when the indicator reaches any of the positions("left",
3991     *                 "right" or "center").
3992     *
3993     * See an example of actionslider usage @ref actionslider_example_page "here"
3994     * @{
3995     */
3996    typedef enum _Elm_Actionslider_Pos
3997      {
3998         ELM_ACTIONSLIDER_NONE = 0,
3999         ELM_ACTIONSLIDER_LEFT = 1 << 0,
4000         ELM_ACTIONSLIDER_CENTER = 1 << 1,
4001         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
4002         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
4003      } Elm_Actionslider_Pos;
4004
4005    /**
4006     * Add a new actionslider to the parent.
4007     *
4008     * @param parent The parent object
4009     * @return The new actionslider object or NULL if it cannot be created
4010     */
4011    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4012    /**
4013     * Set actionslider labels.
4014     *
4015     * @param obj The actionslider object
4016     * @param left_label The label to be set on the left.
4017     * @param center_label The label to be set on the center.
4018     * @param right_label The label to be set on the right.
4019     */
4020    EAPI void                  elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
4021    /**
4022     * Get actionslider labels.
4023     *
4024     * @param obj The actionslider object
4025     * @param left_label A char** to place the left_label of @p obj into.
4026     * @param center_label A char** to place the center_label of @p obj into.
4027     * @param right_label A char** to place the right_label of @p obj into.
4028     */
4029    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);
4030    /**
4031     * Get actionslider selected label.
4032     *
4033     * @param obj The actionslider object
4034     * @return The selected label
4035     */
4036    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4037    /**
4038     * Set actionslider indicator position.
4039     *
4040     * @param obj The actionslider object.
4041     * @param pos The position of the indicator.
4042     */
4043    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
4044    /**
4045     * Get actionslider indicator position.
4046     *
4047     * @param obj The actionslider object.
4048     * @return The position of the indicator.
4049     */
4050    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4051    /**
4052     * Set actionslider magnet position. To make multiple positions magnets @c or
4053     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
4054     *
4055     * @param obj The actionslider object.
4056     * @param pos Bit mask indicating the magnet positions.
4057     */
4058    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
4059    /**
4060     * Get actionslider magnet position.
4061     *
4062     * @param obj The actionslider object.
4063     * @return The positions with magnet property.
4064     */
4065    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4066    /**
4067     * Set actionslider enabled position. To set multiple positions as enabled @c or
4068     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
4069     *
4070     * @note All the positions are enabled by default.
4071     *
4072     * @param obj The actionslider object.
4073     * @param pos Bit mask indicating the enabled positions.
4074     */
4075    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
4076    /**
4077     * Get actionslider enabled position.
4078     *
4079     * @param obj The actionslider object.
4080     * @return The enabled positions.
4081     */
4082    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4083    /**
4084     * Set the label used on the indicator.
4085     *
4086     * @param obj The actionslider object
4087     * @param label The label to be set on the indicator.
4088     */
4089    EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4090    /**
4091     * Get the label used on the indicator object.
4092     *
4093     * @param obj The actionslider object
4094     * @return The indicator label
4095     */
4096    EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4097    /**
4098     * @}
4099     */
4100
4101    /* genlist */
4102    typedef enum _Elm_Genlist_Item_Flags
4103      {
4104         ELM_GENLIST_ITEM_NONE = 0,
4105         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
4106         ELM_GENLIST_ITEM_GROUP = (1 << 1)
4107      } Elm_Genlist_Item_Flags;
4108    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
4109    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
4110    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
4111    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
4112    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
4113    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
4114    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
4115    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
4116
4117    struct _Elm_Genlist_Item_Class
4118      {
4119         const char                *item_style;
4120         struct
4121           {
4122              GenlistItemLabelGetFunc  label_get;
4123              GenlistItemIconGetFunc   icon_get;
4124              GenlistItemStateGetFunc  state_get;
4125              GenlistItemDelFunc       del;
4126              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
4127           } func;
4128         const char                *mode_item_style;
4129      };
4130
4131    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4132    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4133    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
4134    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4135    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
4136    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4137    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
4138    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4139    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
4140    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4141    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
4142    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4143    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
4144    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4145    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4146    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4147    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4148    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4149    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
4150    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4151    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
4152    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4153    /* operations to add items */
4154    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);
4155    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);
4156    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);
4157    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);
4158    EAPI Elm_Genlist_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func,const void *func_data);
4159    EAPI Elm_Genlist_Item *elm_genlist_item_direct_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
4160    /* operations to retrieve existing items */
4161    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4162    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4163    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4164    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);
4165    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4166    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4167    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4168    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);
4169    /* available item styles:
4170     * default
4171     * default_style - The text part is a textblock
4172     * double_label
4173     * icon_top_text_bottom
4174     */
4175    /* Genlist Item operation */
4176    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4177    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4178    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4179    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4180    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4181    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4182    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4183    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
4184    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4185    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4186    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4187    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4188    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
4189    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4190    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4191    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4192    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4193    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4194    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4195    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4196    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4197    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4198    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
4199    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4200    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4201    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4202    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
4203    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
4204    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
4205    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);
4206    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4207    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
4208    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4209    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
4210    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4211    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4212    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
4213    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4214    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
4215    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
4216    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
4217    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
4218    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4219    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4220    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
4221    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4222    /** Signals that you can add callbacks for are:
4223     * "clicked,double" - This is called when a user has double-clicked an item.
4224     *                    The event_info parameter is the genlist item that was
4225     *                    double-clicked.
4226     * "selected" - This is called when a user has made an item selected. The
4227     *              event_info parameter is the genlist item that was selected.
4228     * "unselected" - This is called when a user has made an item unselected. The
4229     *                 event_info parameter is the genlist item that was
4230     *                 unselected.
4231     * "expanded" - This is called when elm_genlist_item_expanded_set() is called
4232     *              and the item is now meant to be expanded. The event_info
4233     *              parameter is the genlist item that was indicated to expand.
4234     *              It is the job of this callback to then fill in the child
4235     *              items.
4236     * "contracted" - This is called when elm_genlist_item_expanded_set() is
4237     *                called and the item is now meant to be contracted. The
4238     *                event_info parameter is the genlist item that was indicated
4239     *                to contract. It is the job of this callback to then delete
4240     *                the child items.
4241     * "expand,request" - This is called when a user has indicated they want to
4242     *                    expand a tree branch item. The callback should decide
4243     *                    if the item can expand (has any children) and then call
4244     *                    elm_genlist_item_expanded_set() appropriately to set
4245     *                    the state. The event_info parameter is the genlist item
4246     *                    that was indicated to expand.
4247     * "contract,request" - This is called when a user has indicated they want to
4248     *                      contract a tree branch item. The callback should
4249     *                      decide if the item can contract (has any children)
4250     *                      and then call elm_genlist_item_expanded_set()
4251     *                      appropriately to set the state. The event_info
4252     *                      parameter is the genlist item that was indicated to
4253     *                      contract.
4254     * "realized" - This is called when the item in the list is created as a real
4255     *              evas object. event_info parameter is the genlist item that
4256     *              was created. The object may be deleted at any time, so it is
4257     *              up to the caller to not use the object pointer from
4258     *              elm_genlist_item_object_get() in a way where it may point to
4259     *              freed objects.
4260     * "unrealized" - This is called just before an item is unrealized. After
4261     *                this call icon objects provided will be deleted and the
4262     *                item object itself delete or be put into a floating cache.
4263     * "drag,start,up" - This is called when the item in the list has been
4264     *                   dragged (not scrolled) up.
4265     * "drag,start,down" - This is called when the item in the list has been
4266     *                     dragged (not scrolled) down.
4267     * "drag,start,left" - This is called when the item in the list has been
4268     *                     dragged (not scrolled) left.
4269     * "drag,start,right" - This is called when the item in the list has been
4270     *                      dragged (not scrolled) right.
4271     * "drag,stop" - This is called when the item in the list has stopped being
4272     *               dragged.
4273     * "drag" - This is called when the item in the list is being dragged.
4274     * "longpressed" - This is called when the item is pressed for a certain
4275     *                 amount of time. By default it's 1 second.
4276     * "scroll,edge,top" - This is called when the genlist is scrolled until the
4277     *                     top edge.
4278     * "scroll,edge,bottom" - This is called when the genlist is scrolled until
4279     *                        the bottom edge.
4280     * "scroll,edge,left" - This is called when the genlist is scrolled until the
4281     *                      left edge.
4282     * "scroll,edge,right" - This is called when the genlist is scrolled until
4283     *                       the right edge.
4284     * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
4285     *                       left.
4286     * "multi,swipe,right" - This is called when the genlist is multi-touch
4287     *                       swiped right.
4288     * "multi,swipe,up" - This is called when the genlist is multi-touch swiped
4289     *                    up.
4290     * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
4291     *                      down.
4292     * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
4293     *                     out.
4294     * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
4295     *                    in.
4296     * "swipe" - This is called when the genlist is swiped.
4297     */
4298
4299    /* check */
4300    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4301    EAPI void         elm_check_label_set(Evas_Object *obj, const char *label); EINA_ARG_NONNULL(1)
4302    EAPI const char  *elm_check_label_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
4303    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon); EINA_ARG_NONNULL(1)
4304    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
4305    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj); EINA_ARG_NONNULL(1)
4306    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state); EINA_ARG_NONNULL(1)
4307    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj); EINA_ARG_NONNULL(1)
4308    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep); EINA_ARG_NONNULL(1)
4309    /* smart callbacks called:
4310     * "changed" - This is called whenever the user changes the state of one of the check object.
4311     */
4312
4313    /* radio */
4314    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4315    EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4316    EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4317    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4318    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4319    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4320    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
4321    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
4322    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4323    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
4324    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4325    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
4326    /* smart callbacks called:
4327     * "changed" - when the radio status is changed
4328     */
4329
4330    /* pager */
4331    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4332    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4333    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
4334    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4335    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4336    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4337    /* available item styles:
4338     * default
4339     * fade
4340     * fade_translucide
4341     * fade_invisible
4342     */
4343    /* smart callbacks called:
4344     * "hide,finished" - when the previous page is hided
4345     */
4346
4347    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
4348    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
4349    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
4350    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
4351    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
4352
4353    struct _Elm_Slideshow_Item_Class
4354      {
4355         struct _Elm_Slideshow_Item_Class_Func
4356           {
4357              SlideshowItemGetFunc get;
4358              SlideshowItemDelFunc del;
4359           } func;
4360      };
4361
4362    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4363    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
4364    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);
4365    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
4366    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
4367    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
4368    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4369    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
4370    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4371    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
4372    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4373    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
4374    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4375    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4376    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4377    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
4378    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
4379    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4380    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
4381    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
4382    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4383    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
4384    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4385    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
4386    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4387    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
4388    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4389    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4390    /* smart callbacks called:
4391     * "changed" - when the slideshow switch to another item
4392     */
4393
4394    /* file selector */
4395    typedef enum _Elm_Fileselector_Mode
4396      {
4397         ELM_FILESELECTOR_LIST = 0,
4398         ELM_FILESELECTOR_GRID,
4399         ELM_FILESELECTOR_LAST
4400      } Elm_Fileselector_Mode;
4401
4402    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4403    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
4404    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4405    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
4406    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4407    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
4408    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4409    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4410    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
4411    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4412    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4413    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4414    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4415    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
4416    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4417    /* smart callbacks called:
4418     * "selected" - the user click on a file
4419     * "directory,open" - the list is populate with a new content. event_info is a directory.
4420     * "done" - the user click on the ok or cancel buttons
4421     */
4422
4423    /* progressbar */
4424    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4425    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
4426    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4427    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
4428    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
4429    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4430    EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4431    EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4432    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4433    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4434    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4435    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
4436    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4437    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
4438    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4439    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4440    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4441    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
4442    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4443    /* smart callbacks called:
4444     */
4445    /* available item styles:
4446     * default
4447     * wheel (simple style, no text, no progression, only pulse is available)
4448     */
4449
4450    /* separator */
4451    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4452    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4453    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4454    /* smart callbacks called:
4455     */
4456
4457    /* spinner */
4458    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4459    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
4460    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4461    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
4462    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
4463    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
4464    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4465    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
4466    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4467    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
4468    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4469    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
4470    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4471    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
4472    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
4473    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4474    /* smart callbacks called:
4475     * "changed" - when the spinner value changes
4476     * "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).
4477     */
4478    /* available item styles:
4479     * default
4480     * vertical (two up/down buttons at the right side and text left aligned)
4481     */
4482
4483    /* index */
4484    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
4485
4486    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4487    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
4488    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4489    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
4490    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4491    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
4492    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
4493    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
4494    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
4495    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
4496    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);
4497    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
4498    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
4499    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4500    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
4501    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
4502    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
4503    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
4504    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
4505    /* smart callbacks called:
4506     * "changed" - when the selected index item changes
4507     * "delay,changed" - when the selected index item changes, but after some small idle period
4508     * "selected" - when the user releases a finger and selects an item
4509     * "level,up" - when the user moves a finger from the first level to the second level
4510     * "level,down" - when the user moves a finger from the second level to the first level
4511     */
4512
4513    /* photocam */
4514    typedef enum _Elm_Photocam_Zoom_Mode
4515      {
4516         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
4517         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
4518         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
4519         ELM_PHOTOCAM_ZOOM_MODE_LAST
4520      } Elm_Photocam_Zoom_Mode;
4521
4522    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4523    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4524    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4525    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
4526    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4527    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
4528    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4529    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4530    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4531    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4532    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
4533    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
4534    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4535    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4536    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4537    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4538    /* smart callbacks called:
4539     * "clicked" - when image clicked
4540     * "press" - when mouse/finger held down initially on image
4541     * "longpressed" - when mouse/finger held for long time on image
4542     * "clicked,double" - when mouse/finger double-clicked
4543     * "load" - when photo load begins
4544     * "loaded" - when photo load done
4545     * "load,detail" - when detailed image load begins
4546     * "loaded,detail" - when detailed image load done
4547     * "zoom,start" - when zooming started
4548     * "zoom,stop" - when zooming stopped
4549     * "zoom,change" - when auto zoom mode changed zoom level
4550     * "scroll - the content has been scrolled (moved)
4551     * "scroll,anim,start" - scrolling animation has started
4552     * "scroll,anim,stop" - scrolling animation has stopped
4553     * "scroll,drag,start" - dragging the contents around has started
4554     * "scroll,drag,stop" - dragging the contents around has stopped
4555     */
4556
4557    /* map */
4558    typedef enum _Elm_Map_Zoom_Mode
4559      {
4560         ELM_MAP_ZOOM_MODE_MANUAL,
4561         ELM_MAP_ZOOM_MODE_AUTO_FIT,
4562         ELM_MAP_ZOOM_MODE_AUTO_FILL,
4563         ELM_MAP_ZOOM_MODE_LAST
4564      } Elm_Map_Zoom_Mode;
4565
4566    typedef enum _Elm_Map_Route_Sources
4567      {
4568         ELM_MAP_ROUTE_SOURCE_YOURS,
4569         ELM_MAP_ROUTE_SOURCE_MONAV,
4570         ELM_MAP_ROUTE_SOURCE_ORS,
4571         ELM_MAP_ROUTE_SOURCE_LAST
4572      } Elm_Map_Route_Sources;
4573
4574    typedef enum _Elm_Map_Name_Sources
4575      {
4576         ELM_MAP_NAME_SOURCE_NOMINATIM,
4577         ELM_MAP_NAME_SOURCE_LAST
4578      } Elm_Map_Name_Sources;
4579
4580    typedef enum _Elm_Map_Route_Type
4581      {
4582         ELM_MAP_ROUTE_TYPE_MOTOCAR,
4583         ELM_MAP_ROUTE_TYPE_BICYCLE,
4584         ELM_MAP_ROUTE_TYPE_FOOT,
4585         ELM_MAP_ROUTE_TYPE_LAST
4586      } Elm_Map_Route_Type;
4587
4588    typedef enum _Elm_Map_Route_Method
4589      {
4590         ELM_MAP_ROUTE_METHOD_FASTEST,
4591         ELM_MAP_ROUTE_METHOD_SHORTEST,
4592         ELM_MAP_ROUTE_METHOD_LAST
4593      } Elm_Map_Route_Method;
4594
4595    typedef enum _Elm_Map_Name_Method
4596      {
4597         ELM_MAP_NAME_METHOD_SEARCH,
4598         ELM_MAP_NAME_METHOD_REVERSE,
4599         ELM_MAP_NAME_METHOD_LAST
4600      } Elm_Map_Name_Method;
4601
4602    typedef struct _Elm_Map_Marker          Elm_Map_Marker;
4603    typedef struct _Elm_Map_Marker_Class    Elm_Map_Marker_Class;
4604    typedef struct _Elm_Map_Group_Class     Elm_Map_Group_Class;
4605    typedef struct _Elm_Map_Route           Elm_Map_Route;
4606    typedef struct _Elm_Map_Name            Elm_Map_Name;
4607    typedef struct _Elm_Map_Track           Elm_Map_Track;
4608
4609    typedef Evas_Object *(*ElmMapMarkerGetFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
4610    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
4611    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
4612    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data);
4613
4614    typedef char        *(*ElmMapModuleSourceFunc) (void);
4615    typedef int          (*ElmMapModuleZoomMinFunc) (void);
4616    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
4617    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
4618    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
4619    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
4620    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
4621    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
4622    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
4623
4624    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4625    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
4626    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4627    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
4628    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4629    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
4630    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
4631    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
4632    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
4633    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4634    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
4635    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4636    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
4637    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);
4638    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);
4639    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
4640    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
4641    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);
4642    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);
4643    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
4644    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4645    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
4646    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4647    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4648    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
4649    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4650    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
4651    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
4652    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
4653    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
4654    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
4655    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
4656    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
4657    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
4658    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
4659    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
4660    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
4661    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
4662    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
4663    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
4664    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4665    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
4666    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4667    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
4668    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4669    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
4670    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4671    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
4672    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4673    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
4674    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4675    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);
4676    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4677    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
4678    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
4679    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4680    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4681    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
4682    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
4683    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
4684    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
4685    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
4686    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);
4687    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4688    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4689 #ifdef ELM_EMAP
4690    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
4691 #endif
4692    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
4693
4694    /* smart callbacks called:
4695     * "clicked" - when image clicked
4696     * "press" - when mouse/finger held down initially on image
4697     * "longpressed" - when mouse/finger held for long time on image
4698     * "clicked,double" - when mouse/finger double-clicked
4699     * "load,details" - when detailed image load begins
4700     * "loaded,details" - when detailed image load done
4701     * "zoom,start" - when zooming started
4702     * "zoom,stop" - when zooming stopped
4703     * "zoom,change" - when auto zoom mode changed zoom level
4704     * "scroll - the content has been scrolled (moved)
4705     * "scroll,anim,start" - scrolling animation has started
4706     * "scroll,anim,stop" - scrolling animation has stopped
4707     * "scroll,drag,start" - dragging the contents around has started
4708     * "scroll,drag,stop" - dragging the contents around has stopped
4709     */
4710
4711    /* Route */
4712    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
4713 #ifdef ELM_EMAP
4714    EAPI Eina_Bool elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
4715 #endif
4716    EAPI double elm_route_lon_min_get(Evas_Object *obj);
4717    EAPI double elm_route_lat_min_get(Evas_Object *obj);
4718    EAPI double elm_route_lon_max_get(Evas_Object *obj);
4719    EAPI double elm_route_lat_max_get(Evas_Object *obj);
4720
4721
4722    /* panel */
4723    typedef enum _Elm_Panel_Orient
4724      {
4725         ELM_PANEL_ORIENT_TOP,
4726         ELM_PANEL_ORIENT_BOTTOM,
4727         ELM_PANEL_ORIENT_LEFT,
4728         ELM_PANEL_ORIENT_RIGHT,
4729      } Elm_Panel_Orient;
4730
4731    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4732    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
4733    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4734    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4735    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4736    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4737    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
4738    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4739    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
4740
4741    /* panes */
4742    /**
4743     * TODO
4744     *
4745     * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
4746     * Add events (move, start ...)
4747     */
4748    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4749    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4750    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4751    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4752    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4753    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4754    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4755    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4756    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
4757    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4758    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4759
4760    /* flip */
4761    typedef enum _Elm_Flip_Mode
4762      {
4763         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
4764         ELM_FLIP_ROTATE_X_CENTER_AXIS,
4765         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
4766         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
4767         ELM_FLIP_CUBE_LEFT,
4768         ELM_FLIP_CUBE_RIGHT,
4769         ELM_FLIP_CUBE_UP,
4770         ELM_FLIP_CUBE_DOWN,
4771         ELM_FLIP_PAGE_LEFT,
4772         ELM_FLIP_PAGE_RIGHT,
4773         ELM_FLIP_PAGE_UP,
4774         ELM_FLIP_PAGE_DOWN
4775      } Elm_Flip_Mode;
4776    typedef enum _Elm_Flip_Interaction
4777      {
4778         ELM_FLIP_INTERACTION_NONE,
4779         ELM_FLIP_INTERACTION_ROTATE,
4780         ELM_FLIP_INTERACTION_CUBE,
4781         ELM_FLIP_INTERACTION_PAGE
4782      } Elm_Flip_Interaction;
4783    typedef enum _Elm_Flip_Direction
4784      {
4785         ELM_FLIP_DIRECTION_UP,
4786         ELM_FLIP_DIRECTION_DOWN,
4787         ELM_FLIP_DIRECTION_LEFT,
4788         ELM_FLIP_DIRECTION_RIGHT
4789      } Elm_Flip_Direction;
4790
4791    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4792    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4793    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4794    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4795    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4796    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4797    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4798    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4799    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
4800    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
4801    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
4802    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
4803    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
4804    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
4805    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
4806    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
4807    /* smart callbacks called:
4808     * "animate,begin" - when a flip animation was started
4809     * "animate,done" - when a flip animation is finished
4810     */
4811
4812    /* scrolledentry */
4813    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4814    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
4815    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4816    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
4817    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4818    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4819    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4820    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4821    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4822    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4823    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4824    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
4825    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
4826    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4827    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
4828    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4829    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
4830    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
4831    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
4832    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
4833    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4834    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4835    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4836    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4837    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4838    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4839    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4840    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4841    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4842    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
4843    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4844    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
4845    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
4846    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
4847    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4848    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);
4849    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4850    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4851    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);
4852    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4853    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);
4854    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
4855    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4856    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4857    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
4858    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
4859    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4860    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4861    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
4862    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);
4863    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);
4864    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);
4865    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);
4866    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);
4867    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);
4868    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
4869    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
4870    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
4871    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
4872    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4873    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
4874    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4875
4876    /* conformant */
4877    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4878    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4879    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4880    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4881    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4882
4883    /* mapbuf */
4884    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4885    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4886    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4887    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4888    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4889    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4890    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4891    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4892    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4893    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4894
4895    /* flipselector */
4896    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item;
4897
4898    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4899    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
4900    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
4901    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, void (*func)(void *data, Evas_Object *obj, void *event_info), void *data) EINA_ARG_NONNULL(1);
4902    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, void (*func)(void *data, Evas_Object *obj, void *event_info), void *data) EINA_ARG_NONNULL(1);
4903    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4904    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4905    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4906    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4907    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
4908    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
4909    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
4910    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
4911    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
4912    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
4913    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
4914    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
4915    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4916    /* smart callbacks called:
4917     * "selected" - when flipselector selected item is changed
4918     * "overflowed" - when flipselector item is changed to first item
4919     *                from last item
4920     * "underflowed" - when flipselector item is changed to last item
4921     *                 from first item.
4922     */
4923    /* available styles:
4924     * default
4925     */
4926
4927    /**
4928     * @addtogroup Animator Animator
4929     * @ingroup Elementary
4930     *
4931     * @brief Functions to ease creation of animations.
4932     *
4933     * elm_animator is designed to provide an easy way to create animations.
4934     * Creating an animation with elm_animator is as simple as setting a
4935     * duration, an operating callback and telling it to run the animation.
4936     * However that is not the full extent of elm_animator's ability, animations
4937     * can be paused and resumed, reversed and the animation need not be linear.
4938     *
4939     * To run an animation you must specify at least a duration and operation
4940     * callback, not setting any other properties will create a linear animation
4941     * that runs once and is not reversed.
4942     *
4943     * @ref elm_animator_example_page_01 "This" example should make all of that
4944     * very clear.
4945     *
4946     * @warning elm_animator is @b not a widget.
4947     * @{
4948     */
4949    /**
4950     * @brief Type of curve desired for animation.
4951     *
4952     * The speed in which an animation happens doesn't have to be linear, some
4953     * animations will look better if they're accelerating or decelerating, so
4954     * elm_animator provides four options in this regard:
4955     * @image html elm_animator_curve_style.png
4956     * @image latex elm_animator_curve_style.eps width=\textwidth
4957     * As can be seen in the image the speed of the animation will be:
4958     * @li ELM_ANIMATOR_CURVE_LINEAR constant
4959     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
4960     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
4961     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
4962     */
4963    typedef enum
4964      {
4965         ELM_ANIMATOR_CURVE_LINEAR,
4966         ELM_ANIMATOR_CURVE_IN_OUT,
4967         ELM_ANIMATOR_CURVE_IN,
4968         ELM_ANIMATOR_CURVE_OUT
4969      } Elm_Animator_Curve_Style;
4970    typedef struct _Elm_Animator Elm_Animator;
4971   /**
4972    * Called back per loop of an elementary animators cycle
4973    * @param data user-data given to elm_animator_operation_callback_set()
4974    * @param animator the animator being run
4975    * @param double the position in the animation
4976    */
4977    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
4978   /**
4979    * Called back when an elementary animator finishes
4980    * @param data user-data given to elm_animator_completion_callback_set()
4981    */
4982    typedef void (*Elm_Animator_Completion_Cb) (void *data);
4983
4984    /**
4985     * @brief Create a new animator.
4986     *
4987     * @param[in] parent Parent object
4988     *
4989     * The @a parent argument can be set to NULL for no parent. If a parent is set
4990     * there is no need to call elm_animator_del(), when the parent is deleted it
4991     * will delete the animator.
4992     */
4993    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
4994    /**
4995     * Deletes the animator freeing any resources it used. If the animator was
4996     * created with a NULL parent this must be called, otherwise it will be
4997     * automatically called when the parent is deleted.
4998     *
4999     * @param[in] animator Animator object
5000     */
5001    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
5002    /**
5003     * Set the duration of the animation.
5004     *
5005     * @param[in] animator Animator object
5006     * @param[in] duration Duration in second
5007     */
5008    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
5009    /**
5010     * @brief Set the callback function for animator operation.
5011     *
5012     * @param[in] animator Animator object
5013     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
5014     * @param[in] data Callback function user argument
5015     *
5016     * The @p func callback will be called with a frame value in range [0, 1] which
5017     * indicates how far along the animation should be. It is the job of @p func to
5018     * actually change the state of any object(or objects) that are being animated.
5019     */
5020    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
5021    /**
5022     * Set the callback function for the when the animation ends.
5023     *
5024     * @param[in]  animator Animator object
5025     * @param[in]  func   Callback function pointe
5026     * @param[in]  data Callback function user argument
5027     *
5028     * @warning @a func will not be executed if elm_animator_stop() is called.
5029     */
5030    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
5031    /**
5032     * @brief Stop animator.
5033     *
5034     * @param[in] animator Animator object
5035     *
5036     * If called before elm_animator_animate() it does nothing. If there is an
5037     * animation in progress the animation will be stopped(the operation callback
5038     * will not be executed again) and it can't be restarted using
5039     * elm_animator_resume().
5040     */
5041    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
5042    /**
5043     * Set the animator repeat count.
5044     *
5045     * @param[in]  animator Animator object
5046     * @param[in]  repeat_cnt Repeat count
5047     */
5048    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
5049    /**
5050     * @brief Start animation.
5051     *
5052     * @param[in] animator Animator object
5053     *
5054     * This function starts the animation if the nescessary properties(duration
5055     * and operation callback) have been set. Once started the animation will
5056     * run until complete or elm_animator_stop() is called.
5057     */
5058    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
5059    /**
5060     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
5061     *
5062     * @param[in] animator Animator object
5063     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
5064     */
5065    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
5066    /**
5067     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
5068     *
5069     * @param[in] animator Animator object
5070     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
5071     */
5072    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator); EINA_ARG_NONNULL(1);
5073    /**
5074     * @brief Sets wether the animation should be automatically reversed.
5075     *
5076     * @param[in] animator Animator object
5077     * @param[in] reverse Reverse or not
5078     *
5079     * This controls wether the animation will be run on reverse imediately after
5080     * running forward. When this is set together with repetition the animation
5081     * will run in reverse once for each time it ran forward.@n
5082     * Runnin an animation in reverse is accomplished by calling the operation
5083     * callback with a frame value starting at 1 and diminshing until 0.
5084     */
5085    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
5086    /**
5087     * Gets wether the animation will automatically reversed
5088     *
5089     * @param[in] animator Animator object
5090     */
5091    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
5092    /**
5093     * Gets the status for the animator operation. The status of the animator @b
5094     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
5095     * only informs if the animation was started and has not ended(either normally
5096     * or through elm_animator_stop()).
5097     *
5098     * @param[in] animator Animator object
5099     */
5100    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
5101    /**
5102     * Gets how many times the animation will be repeated
5103     *
5104     * @param[in] animator Animator object
5105     */
5106    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
5107    /**
5108     * Pause the animator.
5109     *
5110     * @param[in]  animator Animator object
5111     *
5112     * This causes the animation to be temporarily stopped(the operation callback
5113     * will not be called). If the animation is not yet running this is a no-op.
5114     * Once an animation has been paused with this function it can be resumed
5115     * using elm_animator_resume().
5116     */
5117    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
5118    /**
5119     * @brief Resumes the animator.
5120     *
5121     * @param[in]  animator Animator object
5122     *
5123     * Resumes an animation that was paused using elm_animator_pause(), after
5124     * calling this function calls to the operation callback will happen
5125     * normally. If an animation is stopped by means of elm_animator_stop it
5126     * @b can't be restarted with this function.@n
5127     *
5128     * @warning When an animation is resumed it doesn't start from where it was paused, it
5129     * will go to where it would have been if it had not been paused. If an
5130     * animation with a duration of 3 seconds is paused after 1 second for 1 second
5131     * it will resume as if it had ben animating for 2 seconds, the operating
5132     * callback will be called with a frame value of aproximately 2/3.
5133     */
5134    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
5135    /**
5136     * @}
5137     */
5138
5139    /* calendar */
5140    typedef enum
5141      {
5142         ELM_CALENDAR_UNIQUE,
5143         ELM_CALENDAR_DAILY,
5144         ELM_CALENDAR_WEEKLY,
5145         ELM_CALENDAR_MONTHLY,
5146         ELM_CALENDAR_ANNUALLY
5147      } Elm_Calendar_Mark_Repeat;
5148    typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
5149
5150    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5151    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5152    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
5153    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5154    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
5155    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
5156    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
5157    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5158    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
5159    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
5160    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
5161    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
5162    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);
5163    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
5164    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5165    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5166    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
5167    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5168    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5169    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
5170    /* smart callbacks called:
5171     * changed - emitted when the user select a day or change the displayed
5172     * month.
5173     */
5174
5175    /* diskselector */
5176    typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
5177
5178    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5179    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5180    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
5181    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5182    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
5183    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5184    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
5185    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5186    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5187    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);
5188    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5189    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5190    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5191    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);
5192    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5193    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5194    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5195    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5196    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5197    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5198    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
5199    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5200    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5201    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5202    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5203    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5204    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5205    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5206    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
5207    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);
5208    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5209    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
5210    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5211    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5212    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5213    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5214    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
5215    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5216    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5217    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
5218    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
5219    /* smart callbacks called:
5220     * "selected" - when item is selected (scroller stops)
5221     */
5222
5223    /* colorselector */
5224    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5225    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
5226    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
5227    /* smart callbacks called:
5228     * "changed" - when the color value changes
5229     */
5230
5231    /* Contextual Popup */
5232    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
5233
5234    typedef enum _Elm_Ctxpopup_Direction
5235      {
5236         ELM_CTXPOPUP_DIRECTION_DOWN,
5237         ELM_CTXPOPUP_DIRECTION_RIGHT,
5238         ELM_CTXPOPUP_DIRECTION_LEFT,
5239         ELM_CTXPOPUP_DIRECTION_UP,
5240      } Elm_Ctxpopup_Direction;
5241
5242    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5243    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
5244    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5245    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
5246    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
5247    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
5248    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5249    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5250    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5251    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5252    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);
5253    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
5254    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5255    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
5256    EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
5257    EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5258    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);
5259    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);
5260    /* smart callbacks called:
5261     * "dismissed" - the ctxpopup was dismissed
5262     */
5263
5264    /* transit */
5265    /**
5266     *
5267     * @defgroup Transit Transit
5268     * @ingroup Elementary
5269     *
5270     * Transit is designed to apply various animated transition effects to @c
5271     * Evas_Object, such like translation, rotation, etc. For using these
5272     * effects, create an @ref Elm_Transit and add the desired transition effects.
5273     *
5274     * Once the effects are added into transit, they will be automatically
5275     * managed (their callback will be called until the duration is ended, and
5276     * they will be deleted on completion).
5277     *
5278     * Example:
5279     * @code
5280     * Elm_Transit *trans = elm_transit_add();
5281     * elm_transit_object_add(trans, obj);
5282     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
5283     * elm_transit_duration_set(transit, 1);
5284     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
5285     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
5286     * elm_transit_repeat_times_set(transit, 3);
5287     * @endcode
5288     *
5289     * Some transition effects are used to change the properties of objects. They
5290     * are:
5291     * @li @ref elm_transit_effect_translation_add
5292     * @li @ref elm_transit_effect_color_add
5293     * @li @ref elm_transit_effect_rotation_add
5294     * @li @ref elm_transit_effect_wipe_add
5295     * @li @ref elm_transit_effect_zoom_add
5296     * @li @ref elm_transit_effect_resizing_add
5297     *
5298     * Other transition effects are used to make one object disappear and another
5299     * object appear on its old place. These effects are:
5300     *
5301     * @li @ref elm_transit_effect_flip_add
5302     * @li @ref elm_transit_effect_resizable_flip_add
5303     * @li @ref elm_transit_effect_fade_add
5304     * @li @ref elm_transit_effect_blend_add
5305     *
5306     * It's also possible to make a transition chain with @ref
5307     * elm_transit_chain_transit_add.
5308     *
5309     * @warning We strongly recommend to use elm_transit just when edje can not do
5310     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
5311     * animations can be manipulated inside the theme.
5312     *
5313     * List of examples:
5314     * @li @ref transit_example_01_explained
5315     * @li @ref transit_example_02_explained
5316     * @li @ref transit_example_03_c
5317     * @li @ref transit_example_04_c
5318     *
5319     * @{
5320     */
5321
5322    /**
5323     * @enum Elm_Transit_Tween_Mode
5324     *
5325     * The type of acceleration used in the transition.
5326     */
5327    typedef enum
5328      {
5329         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
5330         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
5331                                              over time, then decrease again
5332                                              and stop slowly */
5333         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
5334                                              speed over time */
5335         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
5336                                             over time */
5337      } Elm_Transit_Tween_Mode;
5338
5339    /**
5340     * @enum Elm_Transit_Effect_Flip_Axis
5341     *
5342     * The axis where flip effect should be applied.
5343     */
5344    typedef enum
5345      {
5346         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
5347         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
5348      } Elm_Transit_Effect_Flip_Axis;
5349    /**
5350     * @enum Elm_Transit_Effect_Wipe_Dir
5351     *
5352     * The direction where the wipe effect should occur.
5353     */
5354    typedef enum
5355      {
5356         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
5357         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
5358         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
5359         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
5360      } Elm_Transit_Effect_Wipe_Dir;
5361    /** @enum Elm_Transit_Effect_Wipe_Type
5362     *
5363     * Whether the wipe effect should show or hide the object.
5364     */
5365    typedef enum
5366      {
5367         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
5368                                              animation */
5369         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
5370                                             animation */
5371      } Elm_Transit_Effect_Wipe_Type;
5372
5373    /**
5374     * @typedef Elm_Transit
5375     *
5376     * The Transit created with elm_transit_add(). This type has the information
5377     * about the objects which the transition will be applied, and the
5378     * transition effects that will be used. It also contains info about
5379     * duration, number of repetitions, auto-reverse, etc.
5380     */
5381    typedef struct _Elm_Transit Elm_Transit;
5382    typedef void Elm_Transit_Effect;
5383    /**
5384     * @typedef Elm_Transit_Effect_Transition_Cb
5385     *
5386     * Transition callback called for this effect on each transition iteration.
5387     */
5388    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
5389    /**
5390     * Elm_Transit_Effect_End_Cb
5391     *
5392     * Transition callback called for this effect when the transition is over.
5393     */
5394    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
5395
5396    /**
5397     * Add new transit.
5398     *
5399     * @note Is not necessary to delete the transit object, it will be deleted at
5400     * the end of its operation.
5401     * @note The transit will start playing when the program enter in the main loop, is not
5402     * necessary to give a start to the transit.
5403     *
5404     * @return The transit object.
5405     *
5406     * @ingroup Transit
5407     */
5408    EAPI Elm_Transit                *elm_transit_add(void);
5409
5410    /**
5411     * Stops the animation and delete the @p transit object.
5412     *
5413     * Call this function if you wants to stop the animation before the duration
5414     * time. Make sure the @p transit object is still alive with
5415     * elm_transit_del_cb_set() function.
5416     * All added effects will be deleted, calling its repective data_free_cb
5417     * functions. The function setted by elm_transit_del_cb_set() will be called.
5418     *
5419     * @see elm_transit_del_cb_set()
5420     *
5421     * @param transit The transit object to be deleted.
5422     *
5423     * @ingroup Transit
5424     * @warning Just call this function if you are sure the transit is alive.
5425     */
5426    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
5427
5428    /**
5429     * Add a new effect to the transit.
5430     *
5431     * @note The cb function and the data are the key to the effect. If you try to
5432     * add an already added effect, nothing is done.
5433     * @note After the first addition of an effect in @p transit, if its
5434     * effect list become empty again, the @p transit will be killed by
5435     * elm_transit_del(transit) function.
5436     *
5437     * Exemple:
5438     * @code
5439     * Elm_Transit *transit = elm_transit_add();
5440     * elm_transit_effect_add(transit,
5441     *                        elm_transit_effect_blend_op,
5442     *                        elm_transit_effect_blend_context_new(),
5443     *                        elm_transit_effect_blend_context_free);
5444     * @endcode
5445     *
5446     * @param transit The transit object.
5447     * @param transition_cb The operation function. It is called when the
5448     * animation begins, it is the function that actually performs the animation.
5449     * It is called with the @p data, @p transit and the time progression of the
5450     * animation (a double value between 0.0 and 1.0).
5451     * @param effect The context data of the effect.
5452     * @param end_cb The function to free the context data, it will be called
5453     * at the end of the effect, it must finalize the animation and free the
5454     * @p data.
5455     *
5456     * @ingroup Transit
5457     * @warning The transit free the context data at the and of the transition with
5458     * the data_free_cb function, do not use the context data in another transit.
5459     */
5460    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);
5461
5462    /**
5463     * Delete an added effect.
5464     *
5465     * This function will remove the effect from the @p transit, calling the
5466     * data_free_cb to free the @p data.
5467     *
5468     * @see elm_transit_effect_add()
5469     *
5470     * @note If the effect is not found, nothing is done.
5471     * @note If the effect list become empty, this function will call
5472     * elm_transit_del(transit), that is, it will kill the @p transit.
5473     *
5474     * @param transit The transit object.
5475     * @param transition_cb The operation function.
5476     * @param effect The context data of the effect.
5477     *
5478     * @ingroup Transit
5479     */
5480    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);
5481
5482    /**
5483     * Add new object to apply the effects.
5484     *
5485     * @note After the first addition of an object in @p transit, if its
5486     * object list become empty again, the @p transit will be killed by
5487     * elm_transit_del(transit) function.
5488     * @note If the @p obj belongs to another transit, the @p obj will be
5489     * removed from it and it will only belong to the @p transit. If the old
5490     * transit stays without objects, it will die.
5491     * @note When you add an object into the @p transit, its state from
5492     * evas_object_pass_events_get(obj) is saved, and it is applied when the
5493     * transit ends, if you change this state whith evas_object_pass_events_set()
5494     * after add the object, this state will change again when @p transit stops to
5495     * run.
5496     *
5497     * @param transit The transit object.
5498     * @param obj Object to be animated.
5499     *
5500     * @ingroup Transit
5501     * @warning It is not allowed to add a new object after transit begins to go.
5502     */
5503    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
5504
5505    /**
5506     * Removes an added object from the transit.
5507     *
5508     * @note If the @p obj is not in the @p transit, nothing is done.
5509     * @note If the list become empty, this function will call
5510     * elm_transit_del(transit), that is, it will kill the @p transit.
5511     *
5512     * @param transit The transit object.
5513     * @param obj Object to be removed from @p transit.
5514     *
5515     * @ingroup Transit
5516     * @warning It is not allowed to remove objects after transit begins to go.
5517     */
5518    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
5519
5520    /**
5521     * Get the objects of the transit.
5522     *
5523     * @param transit The transit object.
5524     * @return a Eina_List with the objects from the transit.
5525     *
5526     * @ingroup Transit
5527     */
5528    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5529
5530    /**
5531     * Enable/disable keeping up the objects states.
5532     * If it is not kept, the objects states will be reset when transition ends.
5533     *
5534     * @note @p transit can not be NULL.
5535     * @note One state includes geometry, color, map data.
5536     *
5537     * @param transit The transit object.
5538     * @param state_keep Keeping or Non Keeping.
5539     *
5540     * @ingroup Transit
5541     */
5542    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
5543
5544    /**
5545     * Get a value whether the objects states will be reset or not.
5546     *
5547     * @note @p transit can not be NULL
5548     *
5549     * @see elm_transit_objects_final_state_keep_set()
5550     *
5551     * @param transit The transit object.
5552     * @return EINA_TRUE means the states of the objects will be reset.
5553     * If @p transit is NULL, EINA_FALSE is returned
5554     *
5555     * @ingroup Transit
5556     */
5557    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5558
5559    /**
5560     * Set the event enabled when transit is operating.
5561     *
5562     * If @p enabled is EINA_TRUE, the objects of the transit will receives
5563     * events from mouse and keyboard during the animation.
5564     * @note When you add an object with elm_transit_object_add(), its state from
5565     * evas_object_pass_events_get(obj) is saved, and it is applied when the
5566     * transit ends, if you change this state with evas_object_pass_events_set()
5567     * after adding the object, this state will change again when @p transit stops
5568     * to run.
5569     *
5570     * @param transit The transit object.
5571     * @param enabled Events are received when enabled is @c EINA_TRUE, and
5572     * ignored otherwise.
5573     *
5574     * @ingroup Transit
5575     */
5576    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
5577
5578    /**
5579     * Get the value of event enabled status.
5580     *
5581     * @see elm_transit_event_enabled_set()
5582     *
5583     * @param transit The Transit object
5584     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
5585     * EINA_FALSE is returned
5586     *
5587     * @ingroup Transit
5588     */
5589    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5590
5591    /**
5592     * Set the user-callback function when the transit is deleted.
5593     *
5594     * @note Using this function twice will overwrite the first function setted.
5595     * @note the @p transit object will be deleted after call @p cb function.
5596     *
5597     * @param transit The transit object.
5598     * @param cb Callback function pointer. This function will be called before
5599     * the deletion of the transit.
5600     * @param data Callback funtion user data. It is the @p op parameter.
5601     *
5602     * @ingroup Transit
5603     */
5604    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, void (*cb)(void *data, Elm_Transit* transit), void *data) EINA_ARG_NONNULL(1);
5605
5606    /**
5607     * Set reverse effect automatically.
5608     *
5609     * If auto reverse is setted, after running the effects with the progress
5610     * parameter from 0 to 1, it will call the effecs again with the progress
5611     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
5612     * where the duration was setted with the function elm_transit_add and
5613     * the repeat with the function elm_transit_repeat_times_set().
5614     *
5615     * @param transit The transit object.
5616     * @param reverse EINA_TRUE means the auto_reverse is on.
5617     *
5618     * @ingroup Transit
5619     */
5620    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
5621
5622    /**
5623     * Get if the auto reverse is on.
5624     *
5625     * @see elm_transit_auto_reverse_set()
5626     *
5627     * @param transit The transit object.
5628     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
5629     * EINA_FALSE is returned
5630     *
5631     * @ingroup Transit
5632     */
5633    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5634
5635    /**
5636     * Set the transit repeat count. Effect will be repeated by repeat count.
5637     *
5638     * This function sets the number of repetition the transit will run after
5639     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
5640     * If the @p repeat is a negative number, it will repeat infinite times.
5641     *
5642     * @note If this function is called during the transit execution, the transit
5643     * will run @p repeat times, ignoring the times it already performed.
5644     *
5645     * @param transit The transit object
5646     * @param repeat Repeat count
5647     *
5648     * @ingroup Transit
5649     */
5650    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
5651
5652    /**
5653     * Get the transit repeat count.
5654     *
5655     * @see elm_transit_repeat_times_set()
5656     *
5657     * @param transit The Transit object.
5658     * @return The repeat count. If @p transit is NULL
5659     * 0 is returned
5660     *
5661     * @ingroup Transit
5662     */
5663    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5664
5665    /**
5666     * Set the transit animation acceleration type.
5667     *
5668     * This function sets the tween mode of the transit that can be:
5669     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
5670     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
5671     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
5672     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
5673     *
5674     * @param transit The transit object.
5675     * @param tween_mode The tween type.
5676     *
5677     * @ingroup Transit
5678     */
5679    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
5680
5681    /**
5682     * Get the transit animation acceleration type.
5683     *
5684     * @note @p transit can not be NULL
5685     *
5686     * @param transit The transit object.
5687     * @return The tween type. If @p transit is NULL
5688     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
5689     *
5690     * @ingroup Transit
5691     */
5692    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5693
5694    /**
5695     * Set the transit animation time
5696     *
5697     * @note @p transit can not be NULL
5698     *
5699     * @param transit The transit object.
5700     * @param duration The animation time.
5701     *
5702     * @ingroup Transit
5703     */
5704    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
5705
5706    /**
5707     * Get the transit animation time
5708     *
5709     * @note @p transit can not be NULL
5710     *
5711     * @param transit The transit object.
5712     *
5713     * @return The transit animation time.
5714     *
5715     * @ingroup Transit
5716     */
5717    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5718
5719    /**
5720     * Starts the transition.
5721     * Once this API is called, the transit begins to measure the time.
5722     *
5723     * @note @p transit can not be NULL
5724     *
5725     * @param transit The transit object.
5726     *
5727     * @ingroup Transit
5728     */
5729    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
5730
5731    /**
5732     * Pause/Resume the transition.
5733     *
5734     * If you call elm_transit_go again, the transit will be started from the
5735     * beginning, and will be unpaused.
5736     *
5737     * @note @p transit can not be NULL
5738     *
5739     * @param transit The transit object.
5740     * @param paused Whether the transition should be paused or not.
5741     *
5742     * @ingroup Transit
5743     */
5744    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
5745
5746    /**
5747     * Get the value of paused status.
5748     *
5749     * @see elm_transit_paused_set()
5750     *
5751     * @note @p transit can not be NULL
5752     *
5753     * @param transit The transit object.
5754     * @return EINA_TRUE means transition is paused. If @p transit is NULL
5755     * EINA_FALSE is returned
5756     *
5757     * @ingroup Transit
5758     */
5759    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5760
5761    /**
5762     * Get the time progression of the animation (a double value between 0.0 and 1.0).
5763     *
5764     * The value returned is a fraction (current time / total time). It
5765     * represents the progression position relative to the total.
5766     *
5767     * @note @p transit can not be NULL
5768     *
5769     * @param transit The transit object.
5770     *
5771     * @return The time progression value. If @p transit is NULL
5772     * 0 is returned
5773     *
5774     * @ingroup Transit
5775     */
5776    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
5777
5778    /**
5779     * Makes the chain relationship between two transits.
5780     *
5781     * @note @p transit can not be NULL. Transit would have multiple chain transits.
5782     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
5783     *
5784     * @param transit The transit object.
5785     * @param chain_transit The chain transit object. This transit will be operated
5786     *        after transit is done.
5787     *
5788     * This function adds @p chain_transit transition to a chain after the @p
5789     * transit, and will be started as soon as @p transit ends. See @ref
5790     * transit_example_02_explained for a full example.
5791     *
5792     * @ingroup Transit
5793     */
5794    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
5795
5796    /**
5797     * Get the current chain transit list.
5798     *
5799     * @note @p transit can not be NULL.
5800     *
5801     * @param transit The transit object.
5802     * @return chain transit list.
5803     *
5804     * @ingroup Transit
5805     */
5806    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
5807
5808    /**
5809     * Add the Resizing Effect to Elm_Transit.
5810     *
5811     * @note This API is one of the facades. It creates resizing effect context
5812     * and add it's required APIs to elm_transit_effect_add.
5813     *
5814     * @see elm_transit_effect_add()
5815     *
5816     * @param transit Transit object.
5817     * @param from_w Object width size when effect begins.
5818     * @param from_h Object height size when effect begins.
5819     * @param to_w Object width size when effect ends.
5820     * @param to_h Object height size when effect ends.
5821     * @return Resizing effect context data.
5822     *
5823     * @ingroup Transit
5824     */
5825    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);
5826
5827    /**
5828     * Add the Translation Effect to Elm_Transit.
5829     *
5830     * @note This API is one of the facades. It creates translation effect context
5831     * and add it's required APIs to elm_transit_effect_add.
5832     *
5833     * @see elm_transit_effect_add()
5834     *
5835     * @param transit Transit object.
5836     * @param from_dx X Position variation when effect begins.
5837     * @param from_dy Y Position variation when effect begins.
5838     * @param to_dx X Position variation when effect ends.
5839     * @param to_dy Y Position variation when effect ends.
5840     * @return Translation effect context data.
5841     *
5842     * @ingroup Transit
5843     * @warning It is highly recommended just create a transit with this effect when
5844     * the window that the objects of the transit belongs has already been created.
5845     * This is because this effect needs the geometry information about the objects,
5846     * and if the window was not created yet, it can get a wrong information.
5847     */
5848    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);
5849
5850    /**
5851     * Add the Zoom Effect to Elm_Transit.
5852     *
5853     * @note This API is one of the facades. It creates zoom effect context
5854     * and add it's required APIs to elm_transit_effect_add.
5855     *
5856     * @see elm_transit_effect_add()
5857     *
5858     * @param transit Transit object.
5859     * @param from_rate Scale rate when effect begins (1 is current rate).
5860     * @param to_rate Scale rate when effect ends.
5861     * @return Zoom effect context data.
5862     *
5863     * @ingroup Transit
5864     * @warning It is highly recommended just create a transit with this effect when
5865     * the window that the objects of the transit belongs has already been created.
5866     * This is because this effect needs the geometry information about the objects,
5867     * and if the window was not created yet, it can get a wrong information.
5868     */
5869    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
5870
5871    /**
5872     * Add the Flip Effect to Elm_Transit.
5873     *
5874     * @note This API is one of the facades. It creates flip effect context
5875     * and add it's required APIs to elm_transit_effect_add.
5876     * @note This effect is applied to each pair of objects in the order they are listed
5877     * in the transit list of objects. The first object in the pair will be the
5878     * "front" object and the second will be the "back" object.
5879     *
5880     * @see elm_transit_effect_add()
5881     *
5882     * @param transit Transit object.
5883     * @param axis Flipping Axis(X or Y).
5884     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
5885     * @return Flip effect context data.
5886     *
5887     * @ingroup Transit
5888     * @warning It is highly recommended just create a transit with this effect when
5889     * the window that the objects of the transit belongs has already been created.
5890     * This is because this effect needs the geometry information about the objects,
5891     * and if the window was not created yet, it can get a wrong information.
5892     */
5893    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
5894
5895    /**
5896     * Add the Resizable Flip Effect to Elm_Transit.
5897     *
5898     * @note This API is one of the facades. It creates resizable flip effect context
5899     * and add it's required APIs to elm_transit_effect_add.
5900     * @note This effect is applied to each pair of objects in the order they are listed
5901     * in the transit list of objects. The first object in the pair will be the
5902     * "front" object and the second will be the "back" object.
5903     *
5904     * @see elm_transit_effect_add()
5905     *
5906     * @param transit Transit object.
5907     * @param axis Flipping Axis(X or Y).
5908     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
5909     * @return Resizable flip effect context data.
5910     *
5911     * @ingroup Transit
5912     * @warning It is highly recommended just create a transit with this effect when
5913     * the window that the objects of the transit belongs has already been created.
5914     * This is because this effect needs the geometry information about the objects,
5915     * and if the window was not created yet, it can get a wrong information.
5916     */
5917    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
5918
5919    /**
5920     * Add the Wipe Effect to Elm_Transit.
5921     *
5922     * @note This API is one of the facades. It creates wipe effect context
5923     * and add it's required APIs to elm_transit_effect_add.
5924     *
5925     * @see elm_transit_effect_add()
5926     *
5927     * @param transit Transit object.
5928     * @param type Wipe type. Hide or show.
5929     * @param dir Wipe Direction.
5930     * @return Wipe effect context data.
5931     *
5932     * @ingroup Transit
5933     * @warning It is highly recommended just create a transit with this effect when
5934     * the window that the objects of the transit belongs has already been created.
5935     * This is because this effect needs the geometry information about the objects,
5936     * and if the window was not created yet, it can get a wrong information.
5937     */
5938    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
5939
5940    /**
5941     * Add the Color Effect to Elm_Transit.
5942     *
5943     * @note This API is one of the facades. It creates color effect context
5944     * and add it's required APIs to elm_transit_effect_add.
5945     *
5946     * @see elm_transit_effect_add()
5947     *
5948     * @param transit        Transit object.
5949     * @param  from_r        RGB R when effect begins.
5950     * @param  from_g        RGB G when effect begins.
5951     * @param  from_b        RGB B when effect begins.
5952     * @param  from_a        RGB A when effect begins.
5953     * @param  to_r          RGB R when effect ends.
5954     * @param  to_g          RGB G when effect ends.
5955     * @param  to_b          RGB B when effect ends.
5956     * @param  to_a          RGB A when effect ends.
5957     * @return               Color effect context data.
5958     *
5959     * @ingroup Transit
5960     */
5961    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);
5962
5963    /**
5964     * Add the Fade Effect to Elm_Transit.
5965     *
5966     * @note This API is one of the facades. It creates fade effect context
5967     * and add it's required APIs to elm_transit_effect_add.
5968     * @note This effect is applied to each pair of objects in the order they are listed
5969     * in the transit list of objects. The first object in the pair will be the
5970     * "before" object and the second will be the "after" object.
5971     *
5972     * @see elm_transit_effect_add()
5973     *
5974     * @param transit Transit object.
5975     * @return Fade effect context data.
5976     *
5977     * @ingroup Transit
5978     * @warning It is highly recommended just create a transit with this effect when
5979     * the window that the objects of the transit belongs has already been created.
5980     * This is because this effect needs the color information about the objects,
5981     * and if the window was not created yet, it can get a wrong information.
5982     */
5983    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
5984
5985    /**
5986     * Add the Blend Effect to Elm_Transit.
5987     *
5988     * @note This API is one of the facades. It creates blend effect context
5989     * and add it's required APIs to elm_transit_effect_add.
5990     * @note This effect is applied to each pair of objects in the order they are listed
5991     * in the transit list of objects. The first object in the pair will be the
5992     * "before" object and the second will be the "after" object.
5993     *
5994     * @see elm_transit_effect_add()
5995     *
5996     * @param transit Transit object.
5997     * @return Blend effect context data.
5998     *
5999     * @ingroup Transit
6000     * @warning It is highly recommended just create a transit with this effect when
6001     * the window that the objects of the transit belongs has already been created.
6002     * This is because this effect needs the color information about the objects,
6003     * and if the window was not created yet, it can get a wrong information.
6004     */
6005    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
6006
6007    /**
6008     * Add the Rotation Effect to Elm_Transit.
6009     *
6010     * @note This API is one of the facades. It creates rotation effect context
6011     * and add it's required APIs to elm_transit_effect_add.
6012     *
6013     * @see elm_transit_effect_add()
6014     *
6015     * @param transit Transit object.
6016     * @param from_degree Degree when effect begins.
6017     * @param to_degree Degree when effect is ends.
6018     * @return Rotation effect context data.
6019     *
6020     * @ingroup Transit
6021     * @warning It is highly recommended just create a transit with this effect when
6022     * the window that the objects of the transit belongs has already been created.
6023     * This is because this effect needs the geometry information about the objects,
6024     * and if the window was not created yet, it can get a wrong information.
6025     */
6026    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
6027
6028    /**
6029     * Add the ImageAnimation Effect to Elm_Transit.
6030     *
6031     * @note This API is one of the facades. It creates image animation effect context
6032     * and add it's required APIs to elm_transit_effect_add.
6033     * The @p images parameter is a list images paths. This list and
6034     * its contents will be deleted at the end of the effect by
6035     * elm_transit_effect_image_animation_context_free() function.
6036     *
6037     * Example:
6038     * @code
6039     * char buf[PATH_MAX];
6040     * Eina_List *images = NULL;
6041     * Elm_Transit *transi = elm_transit_add();
6042     *
6043     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
6044     * images = eina_list_append(images, eina_stringshare_add(buf));
6045     *
6046     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
6047     * images = eina_list_append(images, eina_stringshare_add(buf));
6048     * elm_transit_effect_image_animation_add(transi, images);
6049     *
6050     * @endcode
6051     *
6052     * @see elm_transit_effect_add()
6053     *
6054     * @param transit Transit object.
6055     * @param images Eina_List of images file paths. This list and
6056     * its contents will be deleted at the end of the effect by
6057     * elm_transit_effect_image_animation_context_free() function.
6058     * @return Image Animation effect context data.
6059     *
6060     * @ingroup Transit
6061     */
6062    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
6063    /**
6064     * @}
6065     */
6066
6067   typedef struct _Elm_Store                      Elm_Store;
6068   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
6069   typedef struct _Elm_Store_Item                 Elm_Store_Item;
6070   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
6071   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
6072   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
6073   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
6074   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
6075   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
6076   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
6077   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
6078
6079   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
6080   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
6081   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
6082   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
6083
6084   typedef enum
6085     {
6086        ELM_STORE_ITEM_MAPPING_NONE = 0,
6087        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
6088        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
6089        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
6090        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
6091        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
6092        // can add more here as needed by common apps
6093        ELM_STORE_ITEM_MAPPING_LAST
6094     } Elm_Store_Item_Mapping_Type;
6095
6096   struct _Elm_Store_Item_Mapping_Icon
6097     {
6098        // FIXME: allow edje file icons
6099        int                   w, h;
6100        Elm_Icon_Lookup_Order lookup_order;
6101        Eina_Bool             standard_name : 1;
6102        Eina_Bool             no_scale : 1;
6103        Eina_Bool             smooth : 1;
6104        Eina_Bool             scale_up : 1;
6105        Eina_Bool             scale_down : 1;
6106     };
6107
6108   struct _Elm_Store_Item_Mapping_Empty
6109     {
6110        Eina_Bool             dummy;
6111     };
6112
6113   struct _Elm_Store_Item_Mapping_Photo
6114     {
6115        int                   size;
6116     };
6117
6118   struct _Elm_Store_Item_Mapping_Custom
6119     {
6120        Elm_Store_Item_Mapping_Cb func;
6121     };
6122
6123   struct _Elm_Store_Item_Mapping
6124     {
6125        Elm_Store_Item_Mapping_Type     type;
6126        const char                     *part;
6127        int                             offset;
6128        union
6129          {
6130             Elm_Store_Item_Mapping_Empty  empty;
6131             Elm_Store_Item_Mapping_Icon   icon;
6132             Elm_Store_Item_Mapping_Photo  photo;
6133             Elm_Store_Item_Mapping_Custom custom;
6134             // add more types here
6135          } details;
6136     };
6137
6138   struct _Elm_Store_Item_Info
6139     {
6140       Elm_Genlist_Item_Class       *item_class;
6141       const Elm_Store_Item_Mapping *mapping;
6142       void                         *data;
6143       char                         *sort_id;
6144     };
6145
6146   struct _Elm_Store_Item_Info_Filesystem
6147     {
6148       Elm_Store_Item_Info  base;
6149       char                *path;
6150     };
6151
6152 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
6153 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
6154
6155   EAPI void                    elm_store_free(Elm_Store *st);
6156
6157   EAPI Elm_Store              *elm_store_filesystem_new(void);
6158   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
6159   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
6160   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
6161
6162   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
6163
6164   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
6165   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
6166   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
6167   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
6168   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
6169   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
6170
6171   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
6172   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
6173   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
6174   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
6175   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
6176   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
6177   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
6178
6179    /* SegmentControl */
6180    typedef struct _Elm_Segment_Item Elm_Segment_Item;
6181    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6182    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
6183    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);
6184    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
6185    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
6186    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6187    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
6188    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
6189    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
6190    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
6191    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
6192    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
6193    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
6194    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6195    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
6196    /* smart callbacks called:
6197     * "changed" -when the user clicks on a segment item which is not previously
6198     *            selected and get selected. The event_info parameter is the
6199     *            segment item index.
6200     */
6201
6202    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
6203    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
6204    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
6205    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
6206    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
6207    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
6208    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
6209    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
6210
6211    EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
6212    EAPI void         elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
6213   
6214 #ifdef __cplusplus
6215 }
6216 #endif
6217
6218 #endif