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