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