Elementary: Map Documentation
[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 <Ecore_Con.h>
153 #include <Edje.h>
154
155 #ifdef ELM_EDBUS
156 # include <E_DBus.h>
157 #endif
158
159 #ifdef ELM_EFREET
160 # include <Efreet.h>
161 # include <Efreet_Mime.h>
162 # include <Efreet_Trash.h>
163 #endif
164
165 #ifdef ELM_ETHUMB
166 # include <Ethumb_Client.h>
167 #endif
168
169 #ifdef ELM_EMAP
170 # include <EMap.h>
171 #endif
172
173 #ifdef EAPI
174 # undef EAPI
175 #endif
176
177 #ifdef _WIN32
178 # ifdef ELEMENTARY_BUILD
179 #  ifdef DLL_EXPORT
180 #   define EAPI __declspec(dllexport)
181 #  else
182 #   define EAPI
183 #  endif /* ! DLL_EXPORT */
184 # else
185 #  define EAPI __declspec(dllimport)
186 # endif /* ! EFL_EVAS_BUILD */
187 #else
188 # ifdef __GNUC__
189 #  if __GNUC__ >= 4
190 #   define EAPI __attribute__ ((visibility("default")))
191 #  else
192 #   define EAPI
193 #  endif
194 # else
195 #  define EAPI
196 # endif
197 #endif /* ! _WIN32 */
198
199
200 /* allow usage from c++ */
201 #ifdef __cplusplus
202 extern "C" {
203 #endif
204
205 #define ELM_VERSION_MAJOR @VMAJ@
206 #define ELM_VERSION_MINOR @VMIN@
207
208    typedef struct _Elm_Version
209      {
210         int major;
211         int minor;
212         int micro;
213         int revision;
214      } Elm_Version;
215
216    EAPI extern Elm_Version *elm_version;
217
218 /* handy macros */
219 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
220 #define ELM_PI 3.14159265358979323846
221
222    /**
223     * @defgroup General General
224     *
225     * @brief General Elementary API. Functions that don't relate to
226     * Elementary objects specifically.
227     *
228     * Here are documented functions which init/shutdown the library,
229     * that apply to generic Elementary objects, that deal with
230     * configuration, et cetera.
231     *
232     * @ref general_functions_example_page "This" example contemplates
233     * some of these functions.
234     */
235
236    /**
237     * @addtogroup General
238     * @{
239     */
240
241   /**
242    * Defines couple of standard Evas_Object layers to be used
243    * with evas_object_layer_set().
244    *
245    * @note whenever extending with new values, try to keep some padding
246    *       to siblings so there is room for further extensions.
247    */
248   typedef enum _Elm_Object_Layer
249     {
250        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
251        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
252        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
253        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
254        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
255        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
256     } Elm_Object_Layer;
257
258 /**************************************************************************/
259    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
260
261    /**
262     * Emitted when any Elementary's policy value is changed.
263     */
264    EAPI extern int ELM_EVENT_POLICY_CHANGED;
265
266    /**
267     * @typedef Elm_Event_Policy_Changed
268     *
269     * Data on the event when an Elementary policy has changed
270     */
271     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
272
273    /**
274     * @struct _Elm_Event_Policy_Changed
275     *
276     * Data on the event when an Elementary policy has changed
277     */
278     struct _Elm_Event_Policy_Changed
279      {
280         unsigned int policy; /**< the policy identifier */
281         int          new_value; /**< value the policy had before the change */
282         int          old_value; /**< new value the policy got */
283     };
284
285    /**
286     * Policy identifiers.
287     */
288     typedef enum _Elm_Policy
289     {
290         ELM_POLICY_QUIT, /**< under which circunstances the application
291                           * should quit automatically. @see
292                           * Elm_Policy_Quit.
293                           */
294         ELM_POLICY_LAST
295     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
296  */
297
298    typedef enum _Elm_Policy_Quit
299      {
300         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
301                                    * automatically */
302         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
303                                             * application's last
304                                             * window is closed */
305      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
306
307    typedef enum _Elm_Focus_Direction
308      {
309         ELM_FOCUS_PREVIOUS,
310         ELM_FOCUS_NEXT
311      } Elm_Focus_Direction;
312
313    typedef enum _Elm_Text_Format
314      {
315         ELM_TEXT_FORMAT_PLAIN_UTF8,
316         ELM_TEXT_FORMAT_MARKUP_UTF8
317      } Elm_Text_Format;
318
319    /**
320     * Line wrapping types.
321     */
322    typedef enum _Elm_Wrap_Type
323      {
324         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
325         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
326         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
327         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
328         ELM_WRAP_LAST
329      } Elm_Wrap_Type;
330
331    /**
332     * @typedef Elm_Object_Item
333     * An Elementary Object item handle.
334     * @ingroup General
335     */
336    typedef struct _Elm_Widget_Item Elm_Object_Item;
337
338    /**
339     * Called back when a widget's tooltip is activated and needs content.
340     * @param data user-data given to elm_object_tooltip_content_cb_set()
341     * @param obj owner widget.
342     * @param tooltip The tooltip object (affix content to this!)
343     */
344    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
345
346    /**
347     * Called back when a widget's item tooltip is activated and needs content.
348     * @param data user-data given to elm_object_tooltip_content_cb_set()
349     * @param obj owner widget.
350     * @param tooltip The tooltip object (affix content to this!)
351     * @param item context dependent item. As an example, if tooltip was
352     *        set on Elm_List_Item, then it is of this type.
353     */
354    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
355
356    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
357
358 #ifndef ELM_LIB_QUICKLAUNCH
359 #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 */
360 #else
361 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
362 #endif
363
364 /**************************************************************************/
365    /* General calls */
366
367    /**
368     * Initialize Elementary
369     *
370     * @param[in] argc System's argument count value
371     * @param[in] argv System's pointer to array of argument strings
372     * @return The init counter value.
373     *
374     * This function initializes Elementary and increments a counter of
375     * the number of calls to it. It returs the new counter's value.
376     *
377     * @warning This call is exported only for use by the @c ELM_MAIN()
378     * macro. There is no need to use this if you use this macro (which
379     * is highly advisable). An elm_main() should contain the entry
380     * point code for your application, having the same prototype as
381     * elm_init(), and @b not being static (putting the @c EAPI symbol
382     * in front of its type declaration is advisable). The @c
383     * ELM_MAIN() call should be placed just after it.
384     *
385     * Example:
386     * @dontinclude bg_example_01.c
387     * @skip static void
388     * @until ELM_MAIN
389     *
390     * See the full @ref bg_example_01_c "example".
391     *
392     * @see elm_shutdown().
393     * @ingroup General
394     */
395    EAPI int          elm_init(int argc, char **argv);
396
397    /**
398     * Shut down Elementary
399     *
400     * @return The init counter value.
401     *
402     * This should be called at the end of your application, just
403     * before it ceases to do any more processing. This will clean up
404     * any permanent resources your application may have allocated via
405     * Elementary that would otherwise persist.
406     *
407     * @see elm_init() for an example
408     *
409     * @ingroup General
410     */
411    EAPI int          elm_shutdown(void);
412
413    /**
414     * Run Elementary's main loop
415     *
416     * This call should be issued just after all initialization is
417     * completed. This function will not return until elm_exit() is
418     * called. It will keep looping, running the main
419     * (event/processing) loop for Elementary.
420     *
421     * @see elm_init() for an example
422     *
423     * @ingroup General
424     */
425    EAPI void         elm_run(void);
426
427    /**
428     * Exit Elementary's main loop
429     *
430     * If this call is issued, it will flag the main loop to cease
431     * processing and return back to its parent function (usually your
432     * elm_main() function).
433     *
434     * @see elm_init() for an example. There, just after a request to
435     * close the window comes, the main loop will be left.
436     *
437     * @note By using the #ELM_POLICY_QUIT on your Elementary
438     * applications, you'll this function called automatically for you.
439     *
440     * @ingroup General
441     */
442    EAPI void         elm_exit(void);
443
444    /**
445     * Provide information in order to make Elementary determine the @b
446     * run time location of the software in question, so other data files
447     * such as images, sound files, executable utilities, libraries,
448     * modules and locale files can be found.
449     *
450     * @param mainfunc This is your application's main function name,
451     *        whose binary's location is to be found. Providing @c NULL
452     *        will make Elementary not to use it
453     * @param dom This will be used as the application's "domain", in the
454     *        form of a prefix to any environment variables that may
455     *        override prefix detection and the directory name, inside the
456     *        standard share or data directories, where the software's
457     *        data files will be looked for.
458     * @param checkfile This is an (optional) magic file's path to check
459     *        for existence (and it must be located in the data directory,
460     *        under the share directory provided above). Its presence will
461     *        help determine the prefix found was correct. Pass @c NULL if
462     *        the check is not to be done.
463     *
464     * This function allows one to re-locate the application somewhere
465     * else after compilation, if the developer wishes for easier
466     * distribution of pre-compiled binaries.
467     *
468     * The prefix system is designed to locate where the given software is
469     * installed (under a common path prefix) at run time and then report
470     * specific locations of this prefix and common directories inside
471     * this prefix like the binary, library, data and locale directories,
472     * through the @c elm_app_*_get() family of functions.
473     *
474     * Call elm_app_info_set() early on before you change working
475     * directory or anything about @c argv[0], so it gets accurate
476     * information.
477     *
478     * It will then try and trace back which file @p mainfunc comes from,
479     * if provided, to determine the application's prefix directory.
480     *
481     * The @p dom parameter provides a string prefix to prepend before
482     * environment variables, allowing a fallback to @b specific
483     * environment variables to locate the software. You would most
484     * probably provide a lowercase string there, because it will also
485     * serve as directory domain, explained next. For environment
486     * variables purposes, this string is made uppercase. For example if
487     * @c "myapp" is provided as the prefix, then the program would expect
488     * @c "MYAPP_PREFIX" as a master environment variable to specify the
489     * exact install prefix for the software, or more specific environment
490     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
491     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
492     * the user or scripts before launching. If not provided (@c NULL),
493     * environment variables will not be used to override compiled-in
494     * defaults or auto detections.
495     *
496     * The @p dom string also provides a subdirectory inside the system
497     * shared data directory for data files. For example, if the system
498     * directory is @c /usr/local/share, then this directory name is
499     * appended, creating @c /usr/local/share/myapp, if it @p was @c
500     * "myapp". It is expected the application installs data files in
501     * this directory.
502     *
503     * The @p checkfile is a file name or path of something inside the
504     * share or data directory to be used to test that the prefix
505     * detection worked. For example, your app will install a wallpaper
506     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
507     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
508     * checkfile string.
509     *
510     * @see elm_app_compile_bin_dir_set()
511     * @see elm_app_compile_lib_dir_set()
512     * @see elm_app_compile_data_dir_set()
513     * @see elm_app_compile_locale_set()
514     * @see elm_app_prefix_dir_get()
515     * @see elm_app_bin_dir_get()
516     * @see elm_app_lib_dir_get()
517     * @see elm_app_data_dir_get()
518     * @see elm_app_locale_dir_get()
519     */
520    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
521
522    /**
523     * Provide information on the @b fallback application's binaries
524     * directory, on scenarios where they get overriden by
525     * elm_app_info_set().
526     *
527     * @param dir The path to the default binaries directory (compile time
528     * one)
529     *
530     * @note Elementary will as well use this path to determine actual
531     * names of binaries' directory paths, maybe changing it to be @c
532     * something/local/bin instead of @c something/bin, only, for
533     * example.
534     *
535     * @warning You should call this function @b before
536     * elm_app_info_set().
537     */
538    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
539
540    /**
541     * Provide information on the @b fallback application's libraries
542     * directory, on scenarios where they get overriden by
543     * elm_app_info_set().
544     *
545     * @param dir The path to the default libraries directory (compile
546     * time one)
547     *
548     * @note Elementary will as well use this path to determine actual
549     * names of libraries' directory paths, maybe changing it to be @c
550     * something/lib32 or @c something/lib64 instead of @c something/lib,
551     * only, for example.
552     *
553     * @warning You should call this function @b before
554     * elm_app_info_set().
555     */
556    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
557
558    /**
559     * Provide information on the @b fallback application's data
560     * directory, on scenarios where they get overriden by
561     * elm_app_info_set().
562     *
563     * @param dir The path to the default data directory (compile time
564     * one)
565     *
566     * @note Elementary will as well use this path to determine actual
567     * names of data directory paths, maybe changing it to be @c
568     * something/local/share instead of @c something/share, only, for
569     * example.
570     *
571     * @warning You should call this function @b before
572     * elm_app_info_set().
573     */
574    EAPI void         elm_app_compile_data_dir_set(const char *dir);
575
576    /**
577     * Provide information on the @b fallback application's locale
578     * directory, on scenarios where they get overriden by
579     * elm_app_info_set().
580     *
581     * @param dir The path to the default locale directory (compile time
582     * one)
583     *
584     * @warning You should call this function @b before
585     * elm_app_info_set().
586     */
587    EAPI void         elm_app_compile_locale_set(const char *dir);
588
589    /**
590     * Retrieve the application's run time prefix directory, as set by
591     * elm_app_info_set() and the way (environment) the application was
592     * run from.
593     *
594     * @return The directory prefix the application is actually using
595     */
596    EAPI const char  *elm_app_prefix_dir_get(void);
597
598    /**
599     * Retrieve the application's run time binaries prefix directory, as
600     * set by elm_app_info_set() and the way (environment) the application
601     * was run from.
602     *
603     * @return The binaries directory prefix the application is actually
604     * using
605     */
606    EAPI const char  *elm_app_bin_dir_get(void);
607
608    /**
609     * Retrieve the application's run time libraries prefix directory, as
610     * set by elm_app_info_set() and the way (environment) the application
611     * was run from.
612     *
613     * @return The libraries directory prefix the application is actually
614     * using
615     */
616    EAPI const char  *elm_app_lib_dir_get(void);
617
618    /**
619     * Retrieve the application's run time data prefix directory, as
620     * set by elm_app_info_set() and the way (environment) the application
621     * was run from.
622     *
623     * @return The data directory prefix the application is actually
624     * using
625     */
626    EAPI const char  *elm_app_data_dir_get(void);
627
628    /**
629     * Retrieve the application's run time locale prefix directory, as
630     * set by elm_app_info_set() and the way (environment) the application
631     * was run from.
632     *
633     * @return The locale directory prefix the application is actually
634     * using
635     */
636    EAPI const char  *elm_app_locale_dir_get(void);
637
638    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
639    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
640    EAPI int          elm_quicklaunch_init(int argc, char **argv);
641    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
642    EAPI int          elm_quicklaunch_sub_shutdown(void);
643    EAPI int          elm_quicklaunch_shutdown(void);
644    EAPI void         elm_quicklaunch_seed(void);
645    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
646    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
647    EAPI void         elm_quicklaunch_cleanup(void);
648    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
649    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
650
651    EAPI Eina_Bool    elm_need_efreet(void);
652    EAPI Eina_Bool    elm_need_e_dbus(void);
653    EAPI Eina_Bool    elm_need_ethumb(void);
654
655    /**
656     * Set a new policy's value (for a given policy group/identifier).
657     *
658     * @param policy policy identifier, as in @ref Elm_Policy.
659     * @param value policy value, which depends on the identifier
660     *
661     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
662     *
663     * Elementary policies define applications' behavior,
664     * somehow. These behaviors are divided in policy groups (see
665     * #Elm_Policy enumeration). This call will emit the Ecore event
666     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
667     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
668     * then.
669     *
670     * @note Currently, we have only one policy identifier/group
671     * (#ELM_POLICY_QUIT), which has two possible values.
672     *
673     * @ingroup General
674     */
675    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
676
677    /**
678     * Gets the policy value set for given policy identifier.
679     *
680     * @param policy policy identifier, as in #Elm_Policy.
681     * @return The currently set policy value, for that
682     * identifier. Will be @c 0 if @p policy passed is invalid.
683     *
684     * @ingroup General
685     */
686    EAPI int          elm_policy_get(unsigned int policy);
687
688    /**
689     * Set a label of an object
690     *
691     * @param obj The Elementary object
692     * @param part The text part name to set (NULL for the default label)
693     * @param label The new text of the label
694     *
695     * @note Elementary objects may have many labels (e.g. Action Slider)
696     *
697     * @ingroup General
698     */
699    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
700
701 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
702
703    /**
704     * Get a label of an object
705     *
706     * @param obj The Elementary object
707     * @param part The text part name to get (NULL for the default label)
708     * @return text of the label or NULL for any error
709     *
710     * @note Elementary objects may have many labels (e.g. Action Slider)
711     *
712     * @ingroup General
713     */
714    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
715
716 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
717
718    /**
719     * Set a content of an object
720     *
721     * @param obj The Elementary object
722     * @param part The content part name to set (NULL for the default content)
723     * @param content The new content of the object
724     *
725     * @note Elementary objects may have many contents
726     *
727     * @ingroup General
728     */
729    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
730
731 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
732
733    /**
734     * Get a content of an object
735     *
736     * @param obj The Elementary object
737     * @param item The content part name to get (NULL for the default content)
738     * @return content of the object or NULL for any error
739     *
740     * @note Elementary objects may have many contents
741     *
742     * @ingroup General
743     */
744    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
745
746 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
747
748    /**
749     * Unset a content of an object
750     *
751     * @param obj The Elementary object
752     * @param item The content part name to unset (NULL for the default content)
753     *
754     * @note Elementary objects may have many contents
755     *
756     * @ingroup General
757     */
758    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
759
760 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
761
762    /**
763     * Set a content of an object item
764     *
765     * @param it The Elementary object item
766     * @param part The content part name to unset (NULL for the default content)
767     * @param content The new content of the object item
768     *
769     * @note Elementary object items may have many contents
770     *
771     * @ingroup General
772     */
773    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
774
775 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
776
777    /**
778     * Get a content of an object item
779     *
780     * @param it The Elementary object item
781     * @param part The content part name to unset (NULL for the default content)
782     * @return content of the object item or NULL for any error
783     *
784     * @note Elementary object items may have many contents
785     *
786     * @ingroup General
787     */
788    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
789
790 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
791
792    /**
793     * Unset a content of an object item
794     *
795     * @param it The Elementary object item
796     * @param part The content part name to unset (NULL for the default content)
797     *
798     * @note Elementary object items may have many contents
799     *
800     * @ingroup General
801     */
802    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
803
804 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
805
806    /**
807     * Set a label of an objec itemt
808     *
809     * @param it The Elementary object item
810     * @param part The text part name to set (NULL for the default label)
811     * @param label The new text of the label
812     *
813     * @note Elementary object items may have many labels
814     *
815     * @ingroup General
816     */
817    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
818
819 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
820
821    /**
822     * Get a label of an object
823     *
824     * @param it The Elementary object item
825     * @param part The text part name to get (NULL for the default label)
826     * @return text of the label or NULL for any error
827     *
828     * @note Elementary object items may have many labels
829     *
830     * @ingroup General
831     */
832    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
833
834 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
835
836    /**
837     * @}
838     */
839
840    EAPI void         elm_all_flush(void);
841    EAPI int          elm_cache_flush_interval_get(void);
842    EAPI void         elm_cache_flush_interval_set(int size);
843    EAPI void         elm_cache_flush_interval_all_set(int size);
844    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
845    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
846    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
847    EAPI int          elm_font_cache_get(void);
848    EAPI void         elm_font_cache_set(int size);
849    EAPI void         elm_font_cache_all_set(int size);
850    EAPI int          elm_image_cache_get(void);
851    EAPI void         elm_image_cache_set(int size);
852    EAPI void         elm_image_cache_all_set(int size);
853    EAPI int          elm_edje_file_cache_get(void);
854    EAPI void         elm_edje_file_cache_set(int size);
855    EAPI void         elm_edje_file_cache_all_set(int size);
856    EAPI int          elm_edje_collection_cache_get(void);
857    EAPI void         elm_edje_collection_cache_set(int size);
858    EAPI void         elm_edje_collection_cache_all_set(int size);
859
860    /**
861     * @defgroup Scaling Selective Widget Scaling
862     *
863     * Different widgets can be scaled independently. These functions
864     * allow you to manipulate this scaling on a per-widget basis. The
865     * object and all its children get their scaling factors multiplied
866     * by the scale factor set. This is multiplicative, in that if a
867     * child also has a scale size set it is in turn multiplied by its
868     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
869     * double size, @c 0.5 is half, etc.
870     *
871     * @ref general_functions_example_page "This" example contemplates
872     * some of these functions.
873     */
874
875    /**
876     * Set the scaling factor for a given Elementary object
877     *
878     * @param obj The Elementary to operate on
879     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
880     * no scaling)
881     *
882     * @ingroup Scaling
883     */
884    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
885
886    /**
887     * Get the scaling factor for a given Elementary object
888     *
889     * @param obj The object
890     * @return The scaling factor set by elm_object_scale_set()
891     *
892     * @ingroup Scaling
893     */
894    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
895    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
896    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
897    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
898    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
899    /**
900     * Set the style to use by a widget
901     *
902     * Sets the style name that will define the appearance of a widget. Styles
903     * vary from widget to widget and may also be defined by other themes
904     * by means of extensions and overlays.
905     *
906     * @param obj The Elementary widget to style
907     * @param style The style name to use
908     *
909     * @see elm_theme_extension_add()
910     * @see elm_theme_overlay_add()
911     *
912     * @ingroup Theme
913     */
914    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
915    /**
916     * Get the style used by the widget
917     *
918     * This gets the style being used for that widget. Note that the string
919     * pointer is only valid as longas the object is valid and the style doesn't
920     * change.
921     *
922     * @param obj The Elementary widget to query for its style
923     * @return The style name used
924     *
925     * @see elm_object_style_set()
926     *
927     * @ingroup Theme
928     */
929    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
930
931    /**
932     * @defgroup Styles Styles
933     *
934     * Widgets can have different styles of look. These generic API's
935     * set styles of widgets, if they support them (and if the theme(s)
936     * do).
937     *
938     * @ref general_functions_example_page "This" example contemplates
939     * some of these functions.
940     */
941
942    /**
943     * Set the disabled state of an Elementary object.
944     *
945     * @param obj The Elementary object to operate on
946     * @param disabled The state to put in in: @c EINA_TRUE for
947     *        disabled, @c EINA_FALSE for enabled
948     *
949     * Elementary objects can be @b disabled, in which state they won't
950     * receive input and, in general, will be themed differently from
951     * their normal state, usually greyed out. Useful for contexts
952     * where you don't want your users to interact with some of the
953     * parts of you interface.
954     *
955     * This sets the state for the widget, either disabling it or
956     * enabling it back.
957     *
958     * @ingroup Styles
959     */
960    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
961
962    /**
963     * Get the disabled state of an Elementary object.
964     *
965     * @param obj The Elementary object to operate on
966     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
967     *            if it's enabled (or on errors)
968     *
969     * This gets the state of the widget, which might be enabled or disabled.
970     *
971     * @ingroup Styles
972     */
973    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
974
975    /**
976     * @defgroup WidgetNavigation Widget Tree Navigation.
977     *
978     * How to check if an Evas Object is an Elementary widget? How to
979     * get the first elementary widget that is parent of the given
980     * object?  These are all covered in widget tree navigation.
981     *
982     * @ref general_functions_example_page "This" example contemplates
983     * some of these functions.
984     */
985
986    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
987
988    /**
989     * Get the first parent of the given object that is an Elementary
990     * widget.
991     *
992     * @param obj the Elementary object to query parent from.
993     * @return the parent object that is an Elementary widget, or @c
994     *         NULL, if it was not found.
995     *
996     * Use this to query for an object's parent widget.
997     *
998     * @note Most of Elementary users wouldn't be mixing non-Elementary
999     * smart objects in the objects tree of an application, as this is
1000     * an advanced usage of Elementary with Evas. So, except for the
1001     * application's window, which is the root of that tree, all other
1002     * objects would have valid Elementary widget parents.
1003     *
1004     * @ingroup WidgetNavigation
1005     */
1006    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1007    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1008    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1009
1010    EAPI double       elm_scale_get(void);
1011    EAPI void         elm_scale_set(double scale);
1012    EAPI void         elm_scale_all_set(double scale);
1013
1014    EAPI Eina_Bool    elm_mirrored_get(void);
1015    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1016
1017    EAPI Eina_Bool    elm_config_save(void);
1018    EAPI void         elm_config_reload(void);
1019
1020    EAPI const char  *elm_profile_current_get(void);
1021    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1022    EAPI void         elm_profile_dir_free(const char *p_dir);
1023    EAPI Eina_List   *elm_profile_list_get(void);
1024    EAPI void         elm_profile_list_free(Eina_List *l);
1025    EAPI void         elm_profile_set(const char *profile);
1026    EAPI void         elm_profile_all_set(const char *profile);
1027
1028    EAPI const char  *elm_engine_current_get(void);
1029    EAPI void         elm_engine_set(const char *engine);
1030
1031   typedef struct _Elm_Text_Class
1032     {
1033        const char *name;
1034        const char *desc;
1035     } Elm_Text_Class;
1036
1037   typedef struct _Elm_Font_Overlay
1038     {
1039        const char     *text_class;
1040        const char     *font;
1041        Evas_Font_Size  size;
1042     } Elm_Font_Overlay;
1043
1044   typedef struct _Elm_Font_Properties
1045     {
1046        const char *name;
1047        Eina_List  *styles;
1048     } Elm_Font_Properties;
1049
1050    EAPI const Eina_List     *elm_text_classes_list_get(void);
1051    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1052
1053    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1054    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1055    EAPI void                 elm_font_overlay_unset(const char *text_class);
1056    EAPI void                 elm_font_overlay_apply(void);
1057    EAPI void                 elm_font_overlay_all_apply(void);
1058
1059    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1060    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1061    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1062    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1063    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
1064    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
1065
1066    /**
1067     * @defgroup Fingers Fingers
1068     *
1069     * Elementary is designed to be finger-friendly for touchscreens,
1070     * and so in addition to scaling for display resolution, it can
1071     * also scale based on finger "resolution" (or size). You can then
1072     * customize the granularity of the areas meant to receive clicks
1073     * on touchscreens.
1074     *
1075     * Different profiles may have pre-set values for finger sizes.
1076     *
1077     * @ref general_functions_example_page "This" example contemplates
1078     * some of these functions.
1079     */
1080
1081    /**
1082     * Get the configured "finger size"
1083     *
1084     * @return The finger size
1085     *
1086     * This gets the globally configured finger size, <b>in pixels</b>
1087     *
1088     * @ingroup Fingers
1089     */
1090    EAPI Evas_Coord       elm_finger_size_get(void);
1091    EAPI void             elm_finger_size_set(Evas_Coord size);
1092    EAPI void             elm_finger_size_all_set(Evas_Coord size);
1093
1094    /**
1095     * @defgroup Focus Focus
1096     *
1097     * An Elementary application has, at all times, one (and only one)
1098     * @b focused object. This is what determines where the input
1099     * events go to within the application's window. Also, focused
1100     * objects can be decorated differently, in order to signal to the
1101     * user where the input is, at a given moment.
1102     *
1103     * Elementary applications also have the concept of <b>focus
1104     * chain</b>: one can cycle through all the windows' focusable
1105     * objects by input (tab key) or programmatically. The default
1106     * focus chain for an application is the one define by the order in
1107     * which the widgets where added in code. One will cycle through
1108     * top level widgets, and, for each one containg sub-objects, cycle
1109     * through them all, before returning to the level
1110     * above. Elementary also allows one to set @b custom focus chains
1111     * for their applications.
1112     *
1113     * Besides the focused decoration a widget may exhibit, when it
1114     * gets focus, Elementary has a @b global focus highlight object
1115     * that can be enabled for a window. If one chooses to do so, this
1116     * extra highlight effect will surround the current focused object,
1117     * too.
1118     *
1119     * @note Some Elementary widgets are @b unfocusable, after
1120     * creation, by their very nature: they are not meant to be
1121     * interacted with input events, but are there just for visual
1122     * purposes.
1123     *
1124     * @ref general_functions_example_page "This" example contemplates
1125     * some of these functions.
1126     */
1127
1128    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
1129    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
1130    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
1131    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
1132
1133    /**
1134     * Get the whether an Elementary object has the focus or not.
1135     *
1136     * @param obj The Elementary object to get the information from
1137     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1138     *            not (and on errors).
1139     *
1140     * @see elm_object_focus()
1141     *
1142     * @ingroup Focus
1143     */
1144    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1145
1146    /**
1147     * Set/unset focus to a given Elementary object.
1148     *
1149     * @param obj The Elementary object to operate on.
1150     * @param enable @c EINA_TRUE Set focus to a given object,
1151     *               @c EINA_FALSE Unset focus to a given object.
1152     *
1153     * @note When you set focus to this object, if it can handle focus, will
1154     * take the focus away from the one who had it previously and will, for
1155     * now on, be the one receiving input events. Unsetting focus will remove
1156     * the focus from @p obj, passing it back to the previous element in the
1157     * focus chain list.
1158     *
1159     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1160     *
1161     * @ingroup Focus
1162     */
1163    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1164
1165    /**
1166     * Make a given Elementary object the focused one.
1167     *
1168     * @param obj The Elementary object to make focused.
1169     *
1170     * @note This object, if it can handle focus, will take the focus
1171     * away from the one who had it previously and will, for now on, be
1172     * the one receiving input events.
1173     *
1174     * @see elm_object_focus_get()
1175     * @deprecated use elm_object_focus_set() instead.
1176     *
1177     * @ingroup Focus
1178     */
1179    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1180
1181    /**
1182     * Remove the focus from an Elementary object
1183     *
1184     * @param obj The Elementary to take focus from
1185     *
1186     * This removes the focus from @p obj, passing it back to the
1187     * previous element in the focus chain list.
1188     *
1189     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1190     * @deprecated use elm_object_focus_set() instead.
1191     *
1192     * @ingroup Focus
1193     */
1194    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1195
1196    /**
1197     * Set the ability for an Element object to be focused
1198     *
1199     * @param obj The Elementary object to operate on
1200     * @param enable @c EINA_TRUE if the object can be focused, @c
1201     *        EINA_FALSE if not (and on errors)
1202     *
1203     * This sets whether the object @p obj is able to take focus or
1204     * not. Unfocusable objects do nothing when programmatically
1205     * focused, being the nearest focusable parent object the one
1206     * really getting focus. Also, when they receive mouse input, they
1207     * will get the event, but not take away the focus from where it
1208     * was previously.
1209     *
1210     * @ingroup Focus
1211     */
1212    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1213
1214    /**
1215     * Get whether an Elementary object is focusable or not
1216     *
1217     * @param obj The Elementary object to operate on
1218     * @return @c EINA_TRUE if the object is allowed to be focused, @c
1219     *             EINA_FALSE if not (and on errors)
1220     *
1221     * @note Objects which are meant to be interacted with by input
1222     * events are created able to be focused, by default. All the
1223     * others are not.
1224     *
1225     * @ingroup Focus
1226     */
1227    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1228
1229    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1230    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1231    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1232    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1233    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1234    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1235    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1236
1237    /**
1238     * Make the elementary object and its children to be unfocusable (or focusable).
1239     *
1240     * @param obj The Elementary object to operate on
1241     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1242     *        @c EINA_FALSE for focusable.
1243     *
1244     * This sets whether the object @p obj and its children objects
1245     * are able to take focus or not. If the tree is set as unfocusable,
1246     * newest focused object which is not in this tree will get focus.
1247     * This API can be helpful for an object to be deleted.
1248     * When an object will be deleted soon, it and its children may not
1249     * want to get focus (by focus reverting or by other focus controls).
1250     * Then, just use this API before deleting.
1251     *
1252     * @see elm_object_tree_unfocusable_get()
1253     *
1254     * @ingroup Focus
1255     */
1256    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1257
1258    /**
1259     * Get whether an Elementary object and its children are unfocusable or not.
1260     *
1261     * @param obj The Elementary object to get the information from
1262     * @return @c EINA_TRUE, if the tree is unfocussable,
1263     *         @c EINA_FALSE if not (and on errors).
1264     *
1265     * @see elm_object_tree_unfocusable_set()
1266     *
1267     * @ingroup Focus
1268     */
1269    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1270
1271    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
1272    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1273    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1274    EAPI double           elm_scroll_bounce_friction_get(void);
1275    EAPI void             elm_scroll_bounce_friction_set(double friction);
1276    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
1277    EAPI double           elm_scroll_page_scroll_friction_get(void);
1278    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
1279    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
1280    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
1281    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
1282    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
1283    EAPI double           elm_scroll_zoom_friction_get(void);
1284    EAPI void             elm_scroll_zoom_friction_set(double friction);
1285    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
1286    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
1287    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1288    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1289    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
1290    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1291    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1292    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
1293    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1294    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1295    EAPI double           elm_scroll_thumbscroll_friction_get(void);
1296    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
1297    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
1298    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
1299    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
1300    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
1301
1302    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1303    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1304    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1305    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1306    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1307    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1308    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1309    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1310
1311    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1312    EAPI void             elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
1313    EAPI void            *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
1314
1315    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1316    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1317
1318    /**
1319     * Adjust size of an element for finger usage.
1320     *
1321     * @param times_w How many fingers should fit horizontally
1322     * @param w Pointer to the width size to adjust
1323     * @param times_h How many fingers should fit vertically
1324     * @param h Pointer to the height size to adjust
1325     *
1326     * This takes width and height sizes (in pixels) as input and a
1327     * size multiple (which is how many fingers you want to place
1328     * within the area, being "finger" the size set by
1329     * elm_finger_size_set()), and adjusts the size to be large enough
1330     * to accommodate the resulting size -- if it doesn't already
1331     * accommodate it. On return the @p w and @p h sizes pointed to by
1332     * these parameters will be modified, on those conditions.
1333     *
1334     * @note This is kind of a low level Elementary call, most useful
1335     * on size evaluation times for widgets. An external user wouldn't
1336     * be calling, most of the time.
1337     *
1338     * @ingroup Fingers
1339     */
1340    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1341
1342    EAPI double           elm_longpress_timeout_get(void);
1343    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
1344
1345    /* debug
1346     * don't use it unless you are sure
1347     */
1348    EAPI void             elm_object_tree_dump(const Evas_Object *top);
1349    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1350
1351
1352    /* theme */
1353    /**
1354     * @defgroup Theme Theme
1355     *
1356     * Elementary uses Edje to theme its widgets, naturally. But for the most
1357     * part this is hidden behind a simpler interface that lets the user set
1358     * extensions and choose the style of widgets in a much easier way.
1359     *
1360     * Instead of thinking in terms of paths to Edje files and their groups
1361     * each time you want to change the appearance of a widget, Elementary
1362     * works so you can add any theme file with extensions or replace the
1363     * main theme at one point in the application, and then just set the style
1364     * of widgets with elm_object_style_set() and related functions. Elementary
1365     * will then look in its list of themes for a matching group and apply it,
1366     * and when the theme changes midway through the application, all widgets
1367     * will be updated accordingly.
1368     *
1369     * There are three concepts you need to know to understand how Elementary
1370     * theming works: default theme, extensions and overlays.
1371     *
1372     * Default theme, obviously enough, is the one that provides the default
1373     * look of all widgets. End users can change the theme used by Elementary
1374     * by setting the @c ELM_THEME environment variable before running an
1375     * application, or globally for all programs using the @c elementary_config
1376     * utility. Applications can change the default theme using elm_theme_set(),
1377     * but this can go against the user wishes, so it's not an adviced practice.
1378     *
1379     * Ideally, applications should find everything they need in the already
1380     * provided theme, but there may be occasions when that's not enough and
1381     * custom styles are required to correctly express the idea. For this
1382     * cases, Elementary has extensions.
1383     *
1384     * Extensions allow the application developer to write styles of its own
1385     * to apply to some widgets. This requires knowledge of how each widget
1386     * is themed, as extensions will always replace the entire group used by
1387     * the widget, so important signals and parts need to be there for the
1388     * object to behave properly (see documentation of Edje for details).
1389     * Once the theme for the extension is done, the application needs to add
1390     * it to the list of themes Elementary will look into, using
1391     * elm_theme_extension_add(), and set the style of the desired widgets as
1392     * he would normally with elm_object_style_set().
1393     *
1394     * Overlays, on the other hand, can replace the look of all widgets by
1395     * overriding the default style. Like extensions, it's up to the application
1396     * developer to write the theme for the widgets it wants, the difference
1397     * being that when looking for the theme, Elementary will check first the
1398     * list of overlays, then the set theme and lastly the list of extensions,
1399     * so with overlays it's possible to replace the default view and every
1400     * widget will be affected. This is very much alike to setting the whole
1401     * theme for the application and will probably clash with the end user
1402     * options, not to mention the risk of ending up with not matching styles
1403     * across the program. Unless there's a very special reason to use them,
1404     * overlays should be avoided for the resons exposed before.
1405     *
1406     * All these theme lists are handled by ::Elm_Theme instances. Elementary
1407     * keeps one default internally and every function that receives one of
1408     * these can be called with NULL to refer to this default (except for
1409     * elm_theme_free()). It's possible to create a new instance of a
1410     * ::Elm_Theme to set other theme for a specific widget (and all of its
1411     * children), but this is as discouraged, if not even more so, than using
1412     * overlays. Don't use this unless you really know what you are doing.
1413     *
1414     * But to be less negative about things, you can look at the following
1415     * examples:
1416     * @li @ref theme_example_01 "Using extensions"
1417     * @li @ref theme_example_02 "Using overlays"
1418     *
1419     * @{
1420     */
1421    /**
1422     * @typedef Elm_Theme
1423     *
1424     * Opaque handler for the list of themes Elementary looks for when
1425     * rendering widgets.
1426     *
1427     * Stay out of this unless you really know what you are doing. For most
1428     * cases, sticking to the default is all a developer needs.
1429     */
1430    typedef struct _Elm_Theme Elm_Theme;
1431
1432    /**
1433     * Create a new specific theme
1434     *
1435     * This creates an empty specific theme that only uses the default theme. A
1436     * specific theme has its own private set of extensions and overlays too
1437     * (which are empty by default). Specific themes do not fall back to themes
1438     * of parent objects. They are not intended for this use. Use styles, overlays
1439     * and extensions when needed, but avoid specific themes unless there is no
1440     * other way (example: you want to have a preview of a new theme you are
1441     * selecting in a "theme selector" window. The preview is inside a scroller
1442     * and should display what the theme you selected will look like, but not
1443     * actually apply it yet. The child of the scroller will have a specific
1444     * theme set to show this preview before the user decides to apply it to all
1445     * applications).
1446     */
1447    EAPI Elm_Theme       *elm_theme_new(void);
1448    /**
1449     * Free a specific theme
1450     *
1451     * @param th The theme to free
1452     *
1453     * This frees a theme created with elm_theme_new().
1454     */
1455    EAPI void             elm_theme_free(Elm_Theme *th);
1456    /**
1457     * Copy the theme fom the source to the destination theme
1458     *
1459     * @param th The source theme to copy from
1460     * @param thdst The destination theme to copy data to
1461     *
1462     * This makes a one-time static copy of all the theme config, extensions
1463     * and overlays from @p th to @p thdst. If @p th references a theme, then
1464     * @p thdst is also set to reference it, with all the theme settings,
1465     * overlays and extensions that @p th had.
1466     */
1467    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1468    /**
1469     * Tell the source theme to reference the ref theme
1470     *
1471     * @param th The theme that will do the referencing
1472     * @param thref The theme that is the reference source
1473     *
1474     * This clears @p th to be empty and then sets it to refer to @p thref
1475     * so @p th acts as an override to @p thref, but where its overrides
1476     * don't apply, it will fall through to @p thref for configuration.
1477     */
1478    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1479    /**
1480     * Return the theme referred to
1481     *
1482     * @param th The theme to get the reference from
1483     * @return The referenced theme handle
1484     *
1485     * This gets the theme set as the reference theme by elm_theme_ref_set().
1486     * If no theme is set as a reference, NULL is returned.
1487     */
1488    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
1489    /**
1490     * Return the default theme
1491     *
1492     * @return The default theme handle
1493     *
1494     * This returns the internal default theme setup handle that all widgets
1495     * use implicitly unless a specific theme is set. This is also often use
1496     * as a shorthand of NULL.
1497     */
1498    EAPI Elm_Theme       *elm_theme_default_get(void);
1499    /**
1500     * Prepends a theme overlay to the list of overlays
1501     *
1502     * @param th The theme to add to, or if NULL, the default theme
1503     * @param item The Edje file path to be used
1504     *
1505     * Use this if your application needs to provide some custom overlay theme
1506     * (An Edje file that replaces some default styles of widgets) where adding
1507     * new styles, or changing system theme configuration is not possible. Do
1508     * NOT use this instead of a proper system theme configuration. Use proper
1509     * configuration files, profiles, environment variables etc. to set a theme
1510     * so that the theme can be altered by simple confiugration by a user. Using
1511     * this call to achieve that effect is abusing the API and will create lots
1512     * of trouble.
1513     *
1514     * @see elm_theme_extension_add()
1515     */
1516    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
1517    /**
1518     * Delete a theme overlay from the list of overlays
1519     *
1520     * @param th The theme to delete from, or if NULL, the default theme
1521     * @param item The name of the theme overlay
1522     *
1523     * @see elm_theme_overlay_add()
1524     */
1525    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
1526    /**
1527     * Appends a theme extension to the list of extensions.
1528     *
1529     * @param th The theme to add to, or if NULL, the default theme
1530     * @param item The Edje file path to be used
1531     *
1532     * This is intended when an application needs more styles of widgets or new
1533     * widget themes that the default does not provide (or may not provide). The
1534     * application has "extended" usage by coming up with new custom style names
1535     * for widgets for specific uses, but as these are not "standard", they are
1536     * not guaranteed to be provided by a default theme. This means the
1537     * application is required to provide these extra elements itself in specific
1538     * Edje files. This call adds one of those Edje files to the theme search
1539     * path to be search after the default theme. The use of this call is
1540     * encouraged when default styles do not meet the needs of the application.
1541     * Use this call instead of elm_theme_overlay_add() for almost all cases.
1542     *
1543     * @see elm_object_style_set()
1544     */
1545    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
1546    /**
1547     * Deletes a theme extension from the list of extensions.
1548     *
1549     * @param th The theme to delete from, or if NULL, the default theme
1550     * @param item The name of the theme extension
1551     *
1552     * @see elm_theme_extension_add()
1553     */
1554    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
1555    /**
1556     * Set the theme search order for the given theme
1557     *
1558     * @param th The theme to set the search order, or if NULL, the default theme
1559     * @param theme Theme search string
1560     *
1561     * This sets the search string for the theme in path-notation from first
1562     * theme to search, to last, delimited by the : character. Example:
1563     *
1564     * "shiny:/path/to/file.edj:default"
1565     *
1566     * See the ELM_THEME environment variable for more information.
1567     *
1568     * @see elm_theme_get()
1569     * @see elm_theme_list_get()
1570     */
1571    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
1572    /**
1573     * Return the theme search order
1574     *
1575     * @param th The theme to get the search order, or if NULL, the default theme
1576     * @return The internal search order path
1577     *
1578     * This function returns a colon separated string of theme elements as
1579     * returned by elm_theme_list_get().
1580     *
1581     * @see elm_theme_set()
1582     * @see elm_theme_list_get()
1583     */
1584    EAPI const char      *elm_theme_get(Elm_Theme *th);
1585    /**
1586     * Return a list of theme elements to be used in a theme.
1587     *
1588     * @param th Theme to get the list of theme elements from.
1589     * @return The internal list of theme elements
1590     *
1591     * This returns the internal list of theme elements (will only be valid as
1592     * long as the theme is not modified by elm_theme_set() or theme is not
1593     * freed by elm_theme_free(). This is a list of strings which must not be
1594     * altered as they are also internal. If @p th is NULL, then the default
1595     * theme element list is returned.
1596     *
1597     * A theme element can consist of a full or relative path to a .edj file,
1598     * or a name, without extension, for a theme to be searched in the known
1599     * theme paths for Elemementary.
1600     *
1601     * @see elm_theme_set()
1602     * @see elm_theme_get()
1603     */
1604    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1605    /**
1606     * Return the full patrh for a theme element
1607     *
1608     * @param f The theme element name
1609     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1610     * @return The full path to the file found.
1611     *
1612     * This returns a string you should free with free() on success, NULL on
1613     * failure. This will search for the given theme element, and if it is a
1614     * full or relative path element or a simple searchable name. The returned
1615     * path is the full path to the file, if searched, and the file exists, or it
1616     * is simply the full path given in the element or a resolved path if
1617     * relative to home. The @p in_search_path boolean pointed to is set to
1618     * EINA_TRUE if the file was a searchable file andis in the search path,
1619     * and EINA_FALSE otherwise.
1620     */
1621    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1622    /**
1623     * Flush the current theme.
1624     *
1625     * @param th Theme to flush
1626     *
1627     * This flushes caches that let elementary know where to find theme elements
1628     * in the given theme. If @p th is NULL, then the default theme is flushed.
1629     * Call this function if source theme data has changed in such a way as to
1630     * make any caches Elementary kept invalid.
1631     */
1632    EAPI void             elm_theme_flush(Elm_Theme *th);
1633    /**
1634     * This flushes all themes (default and specific ones).
1635     *
1636     * This will flush all themes in the current application context, by calling
1637     * elm_theme_flush() on each of them.
1638     */
1639    EAPI void             elm_theme_full_flush(void);
1640    /**
1641     * Set the theme for all elementary using applications on the current display
1642     *
1643     * @param theme The name of the theme to use. Format same as the ELM_THEME
1644     * environment variable.
1645     */
1646    EAPI void             elm_theme_all_set(const char *theme);
1647    /**
1648     * Return a list of theme elements in the theme search path
1649     *
1650     * @return A list of strings that are the theme element names.
1651     *
1652     * This lists all available theme files in the standard Elementary search path
1653     * for theme elements, and returns them in alphabetical order as theme
1654     * element names in a list of strings. Free this with
1655     * elm_theme_name_available_list_free() when you are done with the list.
1656     */
1657    EAPI Eina_List       *elm_theme_name_available_list_new(void);
1658    /**
1659     * Free the list returned by elm_theme_name_available_list_new()
1660     *
1661     * This frees the list of themes returned by
1662     * elm_theme_name_available_list_new(). Once freed the list should no longer
1663     * be used. a new list mys be created.
1664     */
1665    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
1666    /**
1667     * Set a specific theme to be used for this object and its children
1668     *
1669     * @param obj The object to set the theme on
1670     * @param th The theme to set
1671     *
1672     * This sets a specific theme that will be used for the given object and any
1673     * child objects it has. If @p th is NULL then the theme to be used is
1674     * cleared and the object will inherit its theme from its parent (which
1675     * ultimately will use the default theme if no specific themes are set).
1676     *
1677     * Use special themes with great care as this will annoy users and make
1678     * configuration difficult. Avoid any custom themes at all if it can be
1679     * helped.
1680     */
1681    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1682    /**
1683     * Get the specific theme to be used
1684     *
1685     * @param obj The object to get the specific theme from
1686     * @return The specifc theme set.
1687     *
1688     * This will return a specific theme set, or NULL if no specific theme is
1689     * set on that object. It will not return inherited themes from parents, only
1690     * the specific theme set for that specific object. See elm_object_theme_set()
1691     * for more information.
1692     */
1693    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1694    /**
1695     * @}
1696     */
1697
1698    /* win */
1699    /** @defgroup Win Win
1700     *
1701     * @image html img/widget/win/preview-00.png
1702     * @image latex img/widget/win/preview-00.eps
1703     *
1704     * The window class of Elementary.  Contains functions to manipulate
1705     * windows. The Evas engine used to render the window contents is specified
1706     * in the system or user elementary config files (whichever is found last),
1707     * and can be overridden with the ELM_ENGINE environment variable for
1708     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
1709     * compilation setup and modules actually installed at runtime) are (listed
1710     * in order of best supported and most likely to be complete and work to
1711     * lowest quality).
1712     *
1713     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1714     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1715     * rendering in X11)
1716     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1717     * exits)
1718     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1719     * rendering)
1720     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1721     * buffer)
1722     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1723     * rendering using SDL as the buffer)
1724     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1725     * GDI with software)
1726     * @li "dfb", "directfb" (Rendering to a DirectFB window)
1727     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1728     * grayscale using dedicated 8bit software engine in X11)
1729     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1730     * X11 using 16bit software engine)
1731     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1732     * (Windows CE rendering via GDI with 16bit software renderer)
1733     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1734     * buffer with 16bit software renderer)
1735     *
1736     * All engines use a simple string to select the engine to render, EXCEPT
1737     * the "shot" engine. This actually encodes the output of the virtual
1738     * screenshot and how long to delay in the engine string. The engine string
1739     * is encoded in the following way:
1740     *
1741     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1742     *
1743     * Where options are separated by a ":" char if more than one option is
1744     * given, with delay, if provided being the first option and file the last
1745     * (order is important). The delay specifies how long to wait after the
1746     * window is shown before doing the virtual "in memory" rendering and then
1747     * save the output to the file specified by the file option (and then exit).
1748     * If no delay is given, the default is 0.5 seconds. If no file is given the
1749     * default output file is "out.png". Repeat option is for continous
1750     * capturing screenshots. Repeat range is from 1 to 999 and filename is
1751     * fixed to "out001.png" Some examples of using the shot engine:
1752     *
1753     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
1754     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
1755     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
1756     *   ELM_ENGINE="shot:delay=2.0" elementary_test
1757     *   ELM_ENGINE="shot:" elementary_test
1758     *
1759     * Signals that you can add callbacks for are:
1760     *
1761     * @li "delete,request": the user requested to close the window. See
1762     * elm_win_autodel_set().
1763     * @li "focus,in": window got focus
1764     * @li "focus,out": window lost focus
1765     * @li "moved": window that holds the canvas was moved
1766     *
1767     * Examples:
1768     * @li @ref win_example_01
1769     *
1770     * @{
1771     */
1772    /**
1773     * Defines the types of window that can be created
1774     *
1775     * These are hints set on the window so that a running Window Manager knows
1776     * how the window should be handled and/or what kind of decorations it
1777     * should have.
1778     *
1779     * Currently, only the X11 backed engines use them.
1780     */
1781    typedef enum _Elm_Win_Type
1782      {
1783         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
1784                          window. Almost every window will be created with this
1785                          type. */
1786         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
1787         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
1788                            window holding desktop icons. */
1789         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
1790                         be kept on top of any other window by the Window
1791                         Manager. */
1792         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
1793                            similar. */
1794         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
1795         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
1796                            pallete. */
1797         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
1798         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
1799                                  entry in a menubar is clicked. Typically used
1800                                  with elm_win_override_set(). This hint exists
1801                                  for completion only, as the EFL way of
1802                                  implementing a menu would not normally use a
1803                                  separate window for its contents. */
1804         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
1805                               triggered by right-clicking an object. */
1806         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
1807                            explanatory text that typically appear after the
1808                            mouse cursor hovers over an object for a while.
1809                            Typically used with elm_win_override_set() and also
1810                            not very commonly used in the EFL. */
1811         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
1812                                 battery life or a new E-Mail received. */
1813         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
1814                          usually used in the EFL. */
1815         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
1816                        object being dragged across different windows, or even
1817                        applications. Typically used with
1818                        elm_win_override_set(). */
1819         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
1820                                  buffer. No actual window is created for this
1821                                  type, instead the window and all of its
1822                                  contents will be rendered to an image buffer.
1823                                  This allows to have children window inside a
1824                                  parent one just like any other object would
1825                                  be, and do other things like applying @c
1826                                  Evas_Map effects to it. This is the only type
1827                                  of window that requires the @c parent
1828                                  parameter of elm_win_add() to be a valid @c
1829                                  Evas_Object. */
1830      } Elm_Win_Type;
1831
1832    /**
1833     * The differents layouts that can be requested for the virtual keyboard.
1834     *
1835     * When the application window is being managed by Illume, it may request
1836     * any of the following layouts for the virtual keyboard.
1837     */
1838    typedef enum _Elm_Win_Keyboard_Mode
1839      {
1840         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
1841         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
1842         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
1843         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
1844         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
1845         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
1846         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
1847         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
1848         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
1849         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
1850         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
1851         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
1852         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
1853         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
1854         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
1855         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
1856      } Elm_Win_Keyboard_Mode;
1857
1858    /**
1859     * Available commands that can be sent to the Illume manager.
1860     *
1861     * When running under an Illume session, a window may send commands to the
1862     * Illume manager to perform different actions.
1863     */
1864    typedef enum _Elm_Illume_Command
1865      {
1866         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
1867                                          window */
1868         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
1869                                             in the list */
1870         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
1871                                          screen */
1872         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
1873      } Elm_Illume_Command;
1874
1875    /**
1876     * Adds a window object. If this is the first window created, pass NULL as
1877     * @p parent.
1878     *
1879     * @param parent Parent object to add the window to, or NULL
1880     * @param name The name of the window
1881     * @param type The window type, one of #Elm_Win_Type.
1882     *
1883     * The @p parent paramter can be @c NULL for every window @p type except
1884     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
1885     * which the image object will be created.
1886     *
1887     * @return The created object, or NULL on failure
1888     */
1889    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1890    /**
1891     * Add @p subobj as a resize object of window @p obj.
1892     *
1893     *
1894     * Setting an object as a resize object of the window means that the
1895     * @p subobj child's size and position will be controlled by the window
1896     * directly. That is, the object will be resized to match the window size
1897     * and should never be moved or resized manually by the developer.
1898     *
1899     * In addition, resize objects of the window control what the minimum size
1900     * of it will be, as well as whether it can or not be resized by the user.
1901     *
1902     * For the end user to be able to resize a window by dragging the handles
1903     * or borders provided by the Window Manager, or using any other similar
1904     * mechanism, all of the resize objects in the window should have their
1905     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
1906     *
1907     * @param obj The window object
1908     * @param subobj The resize object to add
1909     */
1910    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1911    /**
1912     * Delete @p subobj as a resize object of window @p obj.
1913     *
1914     * This function removes the object @p subobj from the resize objects of
1915     * the window @p obj. It will not delete the object itself, which will be
1916     * left unmanaged and should be deleted by the developer, manually handled
1917     * or set as child of some other container.
1918     *
1919     * @param obj The window object
1920     * @param subobj The resize object to add
1921     */
1922    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1923    /**
1924     * Set the title of the window
1925     *
1926     * @param obj The window object
1927     * @param title The title to set
1928     */
1929    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1930    /**
1931     * Get the title of the window
1932     *
1933     * The returned string is an internal one and should not be freed or
1934     * modified. It will also be rendered invalid if a new title is set or if
1935     * the window is destroyed.
1936     *
1937     * @param obj The window object
1938     * @return The title
1939     */
1940    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1941    /**
1942     * Set the window's autodel state.
1943     *
1944     * When closing the window in any way outside of the program control, like
1945     * pressing the X button in the titlebar or using a command from the
1946     * Window Manager, a "delete,request" signal is emitted to indicate that
1947     * this event occurred and the developer can take any action, which may
1948     * include, or not, destroying the window object.
1949     *
1950     * When the @p autodel parameter is set, the window will be automatically
1951     * destroyed when this event occurs, after the signal is emitted.
1952     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
1953     * and is up to the program to do so when it's required.
1954     *
1955     * @param obj The window object
1956     * @param autodel If true, the window will automatically delete itself when
1957     * closed
1958     */
1959    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1960    /**
1961     * Get the window's autodel state.
1962     *
1963     * @param obj The window object
1964     * @return If the window will automatically delete itself when closed
1965     *
1966     * @see elm_win_autodel_set()
1967     */
1968    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1969    /**
1970     * Activate a window object.
1971     *
1972     * This function sends a request to the Window Manager to activate the
1973     * window pointed by @p obj. If honored by the WM, the window will receive
1974     * the keyboard focus.
1975     *
1976     * @note This is just a request that a Window Manager may ignore, so calling
1977     * this function does not ensure in any way that the window will be the
1978     * active one after it.
1979     *
1980     * @param obj The window object
1981     */
1982    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
1983    /**
1984     * Lower a window object.
1985     *
1986     * Places the window pointed by @p obj at the bottom of the stack, so that
1987     * no other window is covered by it.
1988     *
1989     * If elm_win_override_set() is not set, the Window Manager may ignore this
1990     * request.
1991     *
1992     * @param obj The window object
1993     */
1994    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
1995    /**
1996     * Raise a window object.
1997     *
1998     * Places the window pointed by @p obj at the top of the stack, so that it's
1999     * not covered by any other window.
2000     *
2001     * If elm_win_override_set() is not set, the Window Manager may ignore this
2002     * request.
2003     *
2004     * @param obj The window object
2005     */
2006    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2007    /**
2008     * Set the borderless state of a window.
2009     *
2010     * This function requests the Window Manager to not draw any decoration
2011     * around the window.
2012     *
2013     * @param obj The window object
2014     * @param borderless If true, the window is borderless
2015     */
2016    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2017    /**
2018     * Get the borderless state of a window.
2019     *
2020     * @param obj The window object
2021     * @return If true, the window is borderless
2022     */
2023    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2024    /**
2025     * Set the shaped state of a window.
2026     *
2027     * Shaped windows, when supported, will render the parts of the window that
2028     * has no content, transparent.
2029     *
2030     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2031     * background object or cover the entire window in any other way, or the
2032     * parts of the canvas that have no data will show framebuffer artifacts.
2033     *
2034     * @param obj The window object
2035     * @param shaped If true, the window is shaped
2036     *
2037     * @see elm_win_alpha_set()
2038     */
2039    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2040    /**
2041     * Get the shaped state of a window.
2042     *
2043     * @param obj The window object
2044     * @return If true, the window is shaped
2045     *
2046     * @see elm_win_shaped_set()
2047     */
2048    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2049    /**
2050     * Set the alpha channel state of a window.
2051     *
2052     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2053     * possibly making parts of the window completely or partially transparent.
2054     * This is also subject to the underlying system supporting it, like for
2055     * example, running under a compositing manager. If no compositing is
2056     * available, enabling this option will instead fallback to using shaped
2057     * windows, with elm_win_shaped_set().
2058     *
2059     * @param obj The window object
2060     * @param alpha If true, the window has an alpha channel
2061     *
2062     * @see elm_win_alpha_set()
2063     */
2064    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2065    /**
2066     * Get the transparency state of a window.
2067     *
2068     * @param obj The window object
2069     * @return If true, the window is transparent
2070     *
2071     * @see elm_win_transparent_set()
2072     */
2073    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2074    /**
2075     * Set the transparency state of a window.
2076     *
2077     * Use elm_win_alpha_set() instead.
2078     *
2079     * @param obj The window object
2080     * @param transparent If true, the window is transparent
2081     *
2082     * @see elm_win_alpha_set()
2083     */
2084    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2085    /**
2086     * Get the alpha channel state of a window.
2087     *
2088     * @param obj The window object
2089     * @return If true, the window has an alpha channel
2090     */
2091    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2092    /**
2093     * Set the override state of a window.
2094     *
2095     * A window with @p override set to EINA_TRUE will not be managed by the
2096     * Window Manager. This means that no decorations of any kind will be shown
2097     * for it, moving and resizing must be handled by the application, as well
2098     * as the window visibility.
2099     *
2100     * This should not be used for normal windows, and even for not so normal
2101     * ones, it should only be used when there's a good reason and with a lot
2102     * of care. Mishandling override windows may result situations that
2103     * disrupt the normal workflow of the end user.
2104     *
2105     * @param obj The window object
2106     * @param override If true, the window is overridden
2107     */
2108    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2109    /**
2110     * Get the override state of a window.
2111     *
2112     * @param obj The window object
2113     * @return If true, the window is overridden
2114     *
2115     * @see elm_win_override_set()
2116     */
2117    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2118    /**
2119     * Set the fullscreen state of a window.
2120     *
2121     * @param obj The window object
2122     * @param fullscreen If true, the window is fullscreen
2123     */
2124    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2125    /**
2126     * Get the fullscreen state of a window.
2127     *
2128     * @param obj The window object
2129     * @return If true, the window is fullscreen
2130     */
2131    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2132    /**
2133     * Set the maximized state of a window.
2134     *
2135     * @param obj The window object
2136     * @param maximized If true, the window is maximized
2137     */
2138    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2139    /**
2140     * Get the maximized state of a window.
2141     *
2142     * @param obj The window object
2143     * @return If true, the window is maximized
2144     */
2145    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2146    /**
2147     * Set the iconified state of a window.
2148     *
2149     * @param obj The window object
2150     * @param iconified If true, the window is iconified
2151     */
2152    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2153    /**
2154     * Get the iconified state of a window.
2155     *
2156     * @param obj The window object
2157     * @return If true, the window is iconified
2158     */
2159    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2160    /**
2161     * Set the layer of the window.
2162     *
2163     * What this means exactly will depend on the underlying engine used.
2164     *
2165     * In the case of X11 backed engines, the value in @p layer has the
2166     * following meanings:
2167     * @li < 3: The window will be placed below all others.
2168     * @li > 5: The window will be placed above all others.
2169     * @li other: The window will be placed in the default layer.
2170     *
2171     * @param obj The window object
2172     * @param layer The layer of the window
2173     */
2174    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2175    /**
2176     * Get the layer of the window.
2177     *
2178     * @param obj The window object
2179     * @return The layer of the window
2180     *
2181     * @see elm_win_layer_set()
2182     */
2183    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2184    /**
2185     * Set the rotation of the window.
2186     *
2187     * Most engines only work with multiples of 90.
2188     *
2189     * This function is used to set the orientation of the window @p obj to
2190     * match that of the screen. The window itself will be resized to adjust
2191     * to the new geometry of its contents. If you want to keep the window size,
2192     * see elm_win_rotation_with_resize_set().
2193     *
2194     * @param obj The window object
2195     * @param rotation The rotation of the window, in degrees (0-360),
2196     * counter-clockwise.
2197     */
2198    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2199    /**
2200     * Rotates the window and resizes it.
2201     *
2202     * Like elm_win_rotation_set(), but it also resizes the window's contents so
2203     * that they fit inside the current window geometry.
2204     *
2205     * @param obj The window object
2206     * @param layer The rotation of the window in degrees (0-360),
2207     * counter-clockwise.
2208     */
2209    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2210    /**
2211     * Get the rotation of the window.
2212     *
2213     * @param obj The window object
2214     * @return The rotation of the window in degrees (0-360)
2215     *
2216     * @see elm_win_rotation_set()
2217     * @see elm_win_rotation_with_resize_set()
2218     */
2219    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2220    /**
2221     * Set the sticky state of the window.
2222     *
2223     * Hints the Window Manager that the window in @p obj should be left fixed
2224     * at its position even when the virtual desktop it's on moves or changes.
2225     *
2226     * @param obj The window object
2227     * @param sticky If true, the window's sticky state is enabled
2228     */
2229    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2230    /**
2231     * Get the sticky state of the window.
2232     *
2233     * @param obj The window object
2234     * @return If true, the window's sticky state is enabled
2235     *
2236     * @see elm_win_sticky_set()
2237     */
2238    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2239    /**
2240     * Set if this window is an illume conformant window
2241     *
2242     * @param obj The window object
2243     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2244     */
2245    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2246    /**
2247     * Get if this window is an illume conformant window
2248     *
2249     * @param obj The window object
2250     * @return A boolean if this window is illume conformant or not
2251     */
2252    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2253    /**
2254     * Set a window to be an illume quickpanel window
2255     *
2256     * By default window objects are not quickpanel windows.
2257     *
2258     * @param obj The window object
2259     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2260     */
2261    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2262    /**
2263     * Get if this window is a quickpanel or not
2264     *
2265     * @param obj The window object
2266     * @return A boolean if this window is a quickpanel or not
2267     */
2268    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2269    /**
2270     * Set the major priority of a quickpanel window
2271     *
2272     * @param obj The window object
2273     * @param priority The major priority for this quickpanel
2274     */
2275    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2276    /**
2277     * Get the major priority of a quickpanel window
2278     *
2279     * @param obj The window object
2280     * @return The major priority of this quickpanel
2281     */
2282    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2283    /**
2284     * Set the minor priority of a quickpanel window
2285     *
2286     * @param obj The window object
2287     * @param priority The minor priority for this quickpanel
2288     */
2289    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2290    /**
2291     * Get the minor priority of a quickpanel window
2292     *
2293     * @param obj The window object
2294     * @return The minor priority of this quickpanel
2295     */
2296    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2297    /**
2298     * Set which zone this quickpanel should appear in
2299     *
2300     * @param obj The window object
2301     * @param zone The requested zone for this quickpanel
2302     */
2303    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2304    /**
2305     * Get which zone this quickpanel should appear in
2306     *
2307     * @param obj The window object
2308     * @return The requested zone for this quickpanel
2309     */
2310    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2311    /**
2312     * Set the window to be skipped by keyboard focus
2313     *
2314     * This sets the window to be skipped by normal keyboard input. This means
2315     * a window manager will be asked to not focus this window as well as omit
2316     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2317     *
2318     * Call this and enable it on a window BEFORE you show it for the first time,
2319     * otherwise it may have no effect.
2320     *
2321     * Use this for windows that have only output information or might only be
2322     * interacted with by the mouse or fingers, and never for typing input.
2323     * Be careful that this may have side-effects like making the window
2324     * non-accessible in some cases unless the window is specially handled. Use
2325     * this with care.
2326     *
2327     * @param obj The window object
2328     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2329     */
2330    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2331    /**
2332     * Send a command to the windowing environment
2333     *
2334     * This is intended to work in touchscreen or small screen device
2335     * environments where there is a more simplistic window management policy in
2336     * place. This uses the window object indicated to select which part of the
2337     * environment to control (the part that this window lives in), and provides
2338     * a command and an optional parameter structure (use NULL for this if not
2339     * needed).
2340     *
2341     * @param obj The window object that lives in the environment to control
2342     * @param command The command to send
2343     * @param params Optional parameters for the command
2344     */
2345    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2346    /**
2347     * Get the inlined image object handle
2348     *
2349     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2350     * then the window is in fact an evas image object inlined in the parent
2351     * canvas. You can get this object (be careful to not manipulate it as it
2352     * is under control of elementary), and use it to do things like get pixel
2353     * data, save the image to a file, etc.
2354     *
2355     * @param obj The window object to get the inlined image from
2356     * @return The inlined image object, or NULL if none exists
2357     */
2358    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2359    /**
2360     * Set the enabled status for the focus highlight in a window
2361     *
2362     * This function will enable or disable the focus highlight only for the
2363     * given window, regardless of the global setting for it
2364     *
2365     * @param obj The window where to enable the highlight
2366     * @param enabled The enabled value for the highlight
2367     */
2368    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2369    /**
2370     * Get the enabled value of the focus highlight for this window
2371     *
2372     * @param obj The window in which to check if the focus highlight is enabled
2373     *
2374     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2375     */
2376    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2377    /**
2378     * Set the style for the focus highlight on this window
2379     *
2380     * Sets the style to use for theming the highlight of focused objects on
2381     * the given window. If @p style is NULL, the default will be used.
2382     *
2383     * @param obj The window where to set the style
2384     * @param style The style to set
2385     */
2386    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2387    /**
2388     * Get the style set for the focus highlight object
2389     *
2390     * Gets the style set for this windows highilght object, or NULL if none
2391     * is set.
2392     *
2393     * @param obj The window to retrieve the highlights style from
2394     *
2395     * @return The style set or NULL if none was. Default is used in that case.
2396     */
2397    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2398    /*...
2399     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2400     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2401     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2402     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2403     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2404     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2405     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2406     *
2407     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2408     * (blank mouse, private mouse obj, defaultmouse)
2409     *
2410     */
2411    /**
2412     * Sets the keyboard mode of the window.
2413     *
2414     * @param obj The window object
2415     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2416     */
2417    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2418    /**
2419     * Gets the keyboard mode of the window.
2420     *
2421     * @param obj The window object
2422     * @return The mode, one of #Elm_Win_Keyboard_Mode
2423     */
2424    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2425    /**
2426     * Sets whether the window is a keyboard.
2427     *
2428     * @param obj The window object
2429     * @param is_keyboard If true, the window is a virtual keyboard
2430     */
2431    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2432    /**
2433     * Gets whether the window is a keyboard.
2434     *
2435     * @param obj The window object
2436     * @return If the window is a virtual keyboard
2437     */
2438    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2439
2440    /**
2441     * Get the screen position of a window.
2442     *
2443     * @param obj The window object
2444     * @param x The int to store the x coordinate to
2445     * @param y The int to store the y coordinate to
2446     */
2447    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2448    /**
2449     * @}
2450     */
2451
2452    /**
2453     * @defgroup Inwin Inwin
2454     *
2455     * @image html img/widget/inwin/preview-00.png
2456     * @image latex img/widget/inwin/preview-00.eps
2457     * @image html img/widget/inwin/preview-01.png
2458     * @image latex img/widget/inwin/preview-01.eps
2459     * @image html img/widget/inwin/preview-02.png
2460     * @image latex img/widget/inwin/preview-02.eps
2461     *
2462     * An inwin is a window inside a window that is useful for a quick popup.
2463     * It does not hover.
2464     *
2465     * It works by creating an object that will occupy the entire window, so it
2466     * must be created using an @ref Win "elm_win" as parent only. The inwin
2467     * object can be hidden or restacked below every other object if it's
2468     * needed to show what's behind it without destroying it. If this is done,
2469     * the elm_win_inwin_activate() function can be used to bring it back to
2470     * full visibility again.
2471     *
2472     * There are three styles available in the default theme. These are:
2473     * @li default: The inwin is sized to take over most of the window it's
2474     * placed in.
2475     * @li minimal: The size of the inwin will be the minimum necessary to show
2476     * its contents.
2477     * @li minimal_vertical: Horizontally, the inwin takes as much space as
2478     * possible, but it's sized vertically the most it needs to fit its\
2479     * contents.
2480     *
2481     * Some examples of Inwin can be found in the following:
2482     * @li @ref inwin_example_01
2483     *
2484     * @{
2485     */
2486    /**
2487     * Adds an inwin to the current window
2488     *
2489     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2490     * Never call this function with anything other than the top-most window
2491     * as its parameter, unless you are fond of undefined behavior.
2492     *
2493     * After creating the object, the widget will set itself as resize object
2494     * for the window with elm_win_resize_object_add(), so when shown it will
2495     * appear to cover almost the entire window (how much of it depends on its
2496     * content and the style used). It must not be added into other container
2497     * objects and it needs not be moved or resized manually.
2498     *
2499     * @param parent The parent object
2500     * @return The new object or NULL if it cannot be created
2501     */
2502    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2503    /**
2504     * Activates an inwin object, ensuring its visibility
2505     *
2506     * This function will make sure that the inwin @p obj is completely visible
2507     * by calling evas_object_show() and evas_object_raise() on it, to bring it
2508     * to the front. It also sets the keyboard focus to it, which will be passed
2509     * onto its content.
2510     *
2511     * The object's theme will also receive the signal "elm,action,show" with
2512     * source "elm".
2513     *
2514     * @param obj The inwin to activate
2515     */
2516    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2517    /**
2518     * Set the content of an inwin object.
2519     *
2520     * Once the content object is set, a previously set one will be deleted.
2521     * If you want to keep that old content object, use the
2522     * elm_win_inwin_content_unset() function.
2523     *
2524     * @param obj The inwin object
2525     * @param content The object to set as content
2526     */
2527    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2528    /**
2529     * Get the content of an inwin object.
2530     *
2531     * Return the content object which is set for this widget.
2532     *
2533     * The returned object is valid as long as the inwin is still alive and no
2534     * other content is set on it. Deleting the object will notify the inwin
2535     * about it and this one will be left empty.
2536     *
2537     * If you need to remove an inwin's content to be reused somewhere else,
2538     * see elm_win_inwin_content_unset().
2539     *
2540     * @param obj The inwin object
2541     * @return The content that is being used
2542     */
2543    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2544    /**
2545     * Unset the content of an inwin object.
2546     *
2547     * Unparent and return the content object which was set for this widget.
2548     *
2549     * @param obj The inwin object
2550     * @return The content that was being used
2551     */
2552    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2553    /**
2554     * @}
2555     */
2556    /* X specific calls - won't work on non-x engines (return 0) */
2557    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2558    /* smart callbacks called:
2559     * "delete,request" - the user requested to delete the window
2560     * "focus,in" - window got focus
2561     * "focus,out" - window lost focus
2562     * "moved" - window that holds the canvas was moved
2563     */
2564
2565    /**
2566     * @defgroup Bg Bg
2567     *
2568     * @image html img/widget/bg/preview-00.png
2569     * @image latex img/widget/bg/preview-00.eps
2570     *
2571     * @brief Background object, used for setting a solid color, image or Edje
2572     * group as background to a window or any container object.
2573     *
2574     * The bg object is used for setting a solid background to a window or
2575     * packing into any container object. It works just like an image, but has
2576     * some properties useful to a background, like setting it to tiled,
2577     * centered, scaled or stretched.
2578     *
2579     * Here is some sample code using it:
2580     * @li @ref bg_01_example_page
2581     * @li @ref bg_02_example_page
2582     * @li @ref bg_03_example_page
2583     */
2584
2585    /* bg */
2586    typedef enum _Elm_Bg_Option
2587      {
2588         ELM_BG_OPTION_CENTER,  /**< center the background */
2589         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
2590         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2591         ELM_BG_OPTION_TILE     /**< tile background at its original size */
2592      } Elm_Bg_Option;
2593
2594    /**
2595     * Add a new background to the parent
2596     *
2597     * @param parent The parent object
2598     * @return The new object or NULL if it cannot be created
2599     *
2600     * @ingroup Bg
2601     */
2602    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2603
2604    /**
2605     * Set the file (image or edje) used for the background
2606     *
2607     * @param obj The bg object
2608     * @param file The file path
2609     * @param group Optional key (group in Edje) within the file
2610     *
2611     * This sets the image file used in the background object. The image (or edje)
2612     * will be stretched (retaining aspect if its an image file) to completely fill
2613     * the bg object. This may mean some parts are not visible.
2614     *
2615     * @note  Once the image of @p obj is set, a previously set one will be deleted,
2616     * even if @p file is NULL.
2617     *
2618     * @ingroup Bg
2619     */
2620    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2621
2622    /**
2623     * Get the file (image or edje) used for the background
2624     *
2625     * @param obj The bg object
2626     * @param file The file path
2627     * @param group Optional key (group in Edje) within the file
2628     *
2629     * @ingroup Bg
2630     */
2631    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2632
2633    /**
2634     * Set the option used for the background image
2635     *
2636     * @param obj The bg object
2637     * @param option The desired background option (TILE, SCALE)
2638     *
2639     * This sets the option used for manipulating the display of the background
2640     * image. The image can be tiled or scaled.
2641     *
2642     * @ingroup Bg
2643     */
2644    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2645
2646    /**
2647     * Get the option used for the background image
2648     *
2649     * @param obj The bg object
2650     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2651     *
2652     * @ingroup Bg
2653     */
2654    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2655    /**
2656     * Set the option used for the background color
2657     *
2658     * @param obj The bg object
2659     * @param r
2660     * @param g
2661     * @param b
2662     *
2663     * This sets the color used for the background rectangle. Its range goes
2664     * from 0 to 255.
2665     *
2666     * @ingroup Bg
2667     */
2668    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2669    /**
2670     * Get the option used for the background color
2671     *
2672     * @param obj The bg object
2673     * @param r
2674     * @param g
2675     * @param b
2676     *
2677     * @ingroup Bg
2678     */
2679    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2680
2681    /**
2682     * Set the overlay object used for the background object.
2683     *
2684     * @param obj The bg object
2685     * @param overlay The overlay object
2686     *
2687     * This provides a way for elm_bg to have an 'overlay' that will be on top
2688     * of the bg. Once the over object is set, a previously set one will be
2689     * deleted, even if you set the new one to NULL. If you want to keep that
2690     * old content object, use the elm_bg_overlay_unset() function.
2691     *
2692     * @ingroup Bg
2693     */
2694
2695    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2696
2697    /**
2698     * Get the overlay object used for the background object.
2699     *
2700     * @param obj The bg object
2701     * @return The content that is being used
2702     *
2703     * Return the content object which is set for this widget
2704     *
2705     * @ingroup Bg
2706     */
2707    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2708
2709    /**
2710     * Get the overlay object used for the background object.
2711     *
2712     * @param obj The bg object
2713     * @return The content that was being used
2714     *
2715     * Unparent and return the overlay object which was set for this widget
2716     *
2717     * @ingroup Bg
2718     */
2719    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2720
2721    /**
2722     * Set the size of the pixmap representation of the image.
2723     *
2724     * This option just makes sense if an image is going to be set in the bg.
2725     *
2726     * @param obj The bg object
2727     * @param w The new width of the image pixmap representation.
2728     * @param h The new height of the image pixmap representation.
2729     *
2730     * This function sets a new size for pixmap representation of the given bg
2731     * image. It allows the image to be loaded already in the specified size,
2732     * reducing the memory usage and load time when loading a big image with load
2733     * size set to a smaller size.
2734     *
2735     * NOTE: this is just a hint, the real size of the pixmap may differ
2736     * depending on the type of image being loaded, being bigger than requested.
2737     *
2738     * @ingroup Bg
2739     */
2740    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2741    /* smart callbacks called:
2742     */
2743
2744    /**
2745     * @defgroup Icon Icon
2746     *
2747     * @image html img/widget/icon/preview-00.png
2748     * @image latex img/widget/icon/preview-00.eps
2749     *
2750     * An object that provides standard icon images (delete, edit, arrows, etc.)
2751     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2752     *
2753     * The icon image requested can be in the elementary theme, or in the
2754     * freedesktop.org paths. It's possible to set the order of preference from
2755     * where the image will be used.
2756     *
2757     * This API is very similar to @ref Image, but with ready to use images.
2758     *
2759     * Default images provided by the theme are described below.
2760     *
2761     * The first list contains icons that were first intended to be used in
2762     * toolbars, but can be used in many other places too:
2763     * @li home
2764     * @li close
2765     * @li apps
2766     * @li arrow_up
2767     * @li arrow_down
2768     * @li arrow_left
2769     * @li arrow_right
2770     * @li chat
2771     * @li clock
2772     * @li delete
2773     * @li edit
2774     * @li refresh
2775     * @li folder
2776     * @li file
2777     *
2778     * Now some icons that were designed to be used in menus (but again, you can
2779     * use them anywhere else):
2780     * @li menu/home
2781     * @li menu/close
2782     * @li menu/apps
2783     * @li menu/arrow_up
2784     * @li menu/arrow_down
2785     * @li menu/arrow_left
2786     * @li menu/arrow_right
2787     * @li menu/chat
2788     * @li menu/clock
2789     * @li menu/delete
2790     * @li menu/edit
2791     * @li menu/refresh
2792     * @li menu/folder
2793     * @li menu/file
2794     *
2795     * And here we have some media player specific icons:
2796     * @li media_player/forward
2797     * @li media_player/info
2798     * @li media_player/next
2799     * @li media_player/pause
2800     * @li media_player/play
2801     * @li media_player/prev
2802     * @li media_player/rewind
2803     * @li media_player/stop
2804     *
2805     * Signals that you can add callbacks for are:
2806     *
2807     * "clicked" - This is called when a user has clicked the icon
2808     *
2809     * An example of usage for this API follows:
2810     * @li @ref tutorial_icon
2811     */
2812
2813    /**
2814     * @addtogroup Icon
2815     * @{
2816     */
2817
2818    typedef enum _Elm_Icon_Type
2819      {
2820         ELM_ICON_NONE,
2821         ELM_ICON_FILE,
2822         ELM_ICON_STANDARD
2823      } Elm_Icon_Type;
2824    /**
2825     * @enum _Elm_Icon_Lookup_Order
2826     * @typedef Elm_Icon_Lookup_Order
2827     *
2828     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
2829     * theme, FDO paths, or both?
2830     *
2831     * @ingroup Icon
2832     */
2833    typedef enum _Elm_Icon_Lookup_Order
2834      {
2835         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2836         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2837         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
2838         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
2839      } Elm_Icon_Lookup_Order;
2840
2841    /**
2842     * Add a new icon object to the parent.
2843     *
2844     * @param parent The parent object
2845     * @return The new object or NULL if it cannot be created
2846     *
2847     * @see elm_icon_file_set()
2848     *
2849     * @ingroup Icon
2850     */
2851    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2852    /**
2853     * Set the file that will be used as icon.
2854     *
2855     * @param obj The icon object
2856     * @param file The path to file that will be used as icon image
2857     * @param group The group that the icon belongs to in edje file
2858     *
2859     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2860     *
2861     * @note The icon image set by this function can be changed by
2862     * elm_icon_standard_set().
2863     *
2864     * @see elm_icon_file_get()
2865     *
2866     * @ingroup Icon
2867     */
2868    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2869    /**
2870     * Set a location in memory to be used as an icon
2871     *
2872     * @param obj The icon object
2873     * @param img The binary data that will be used as an image
2874     * @param size The size of binary data @p img
2875     * @param format Optional format of @p img to pass to the image loader
2876     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
2877     *
2878     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2879     *
2880     * @note The icon image set by this function can be changed by
2881     * elm_icon_standard_set().
2882     *
2883     * @ingroup Icon
2884     */
2885    EAPI Eina_Bool             elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key);  EINA_ARG_NONNULL(1, 2);
2886    /**
2887     * Get the file that will be used as icon.
2888     *
2889     * @param obj The icon object
2890     * @param file The path to file that will be used as icon icon image
2891     * @param group The group that the icon belongs to in edje file
2892     *
2893     * @see elm_icon_file_set()
2894     *
2895     * @ingroup Icon
2896     */
2897    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2898    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2899    /**
2900     * Set the icon by icon standards names.
2901     *
2902     * @param obj The icon object
2903     * @param name The icon name
2904     *
2905     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2906     *
2907     * For example, freedesktop.org defines standard icon names such as "home",
2908     * "network", etc. There can be different icon sets to match those icon
2909     * keys. The @p name given as parameter is one of these "keys", and will be
2910     * used to look in the freedesktop.org paths and elementary theme. One can
2911     * change the lookup order with elm_icon_order_lookup_set().
2912     *
2913     * If name is not found in any of the expected locations and it is the
2914     * absolute path of an image file, this image will be used.
2915     *
2916     * @note The icon image set by this function can be changed by
2917     * elm_icon_file_set().
2918     *
2919     * @see elm_icon_standard_get()
2920     * @see elm_icon_file_set()
2921     *
2922     * @ingroup Icon
2923     */
2924    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2925    /**
2926     * Get the icon name set by icon standard names.
2927     *
2928     * @param obj The icon object
2929     * @return The icon name
2930     *
2931     * If the icon image was set using elm_icon_file_set() instead of
2932     * elm_icon_standard_set(), then this function will return @c NULL.
2933     *
2934     * @see elm_icon_standard_set()
2935     *
2936     * @ingroup Icon
2937     */
2938    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2939    /**
2940     * Set the smooth effect for an icon object.
2941     *
2942     * @param obj The icon object
2943     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2944     * otherwise. Default is @c EINA_TRUE.
2945     *
2946     * Set the scaling algorithm to be used when scaling the icon image. Smooth
2947     * scaling provides a better resulting image, but is slower.
2948     *
2949     * The smooth scaling should be disabled when making animations that change
2950     * the icon size, since they will be faster. Animations that don't require
2951     * resizing of the icon can keep the smooth scaling enabled (even if the icon
2952     * is already scaled, since the scaled icon image will be cached).
2953     *
2954     * @see elm_icon_smooth_get()
2955     *
2956     * @ingroup Icon
2957     */
2958    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2959    /**
2960     * Get the smooth effect for an icon object.
2961     *
2962     * @param obj The icon object
2963     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2964     *
2965     * @see elm_icon_smooth_set()
2966     *
2967     * @ingroup Icon
2968     */
2969    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2970    /**
2971     * Disable scaling of this object.
2972     *
2973     * @param obj The icon object.
2974     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2975     * otherwise. Default is @c EINA_FALSE.
2976     *
2977     * This function disables scaling of the icon object through the function
2978     * elm_object_scale_set(). However, this does not affect the object
2979     * size/resize in any way. For that effect, take a look at
2980     * elm_icon_scale_set().
2981     *
2982     * @see elm_icon_no_scale_get()
2983     * @see elm_icon_scale_set()
2984     * @see elm_object_scale_set()
2985     *
2986     * @ingroup Icon
2987     */
2988    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2989    /**
2990     * Get whether scaling is disabled on the object.
2991     *
2992     * @param obj The icon object
2993     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
2994     *
2995     * @see elm_icon_no_scale_set()
2996     *
2997     * @ingroup Icon
2998     */
2999    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3000    /**
3001     * Set if the object is (up/down) resizeable.
3002     *
3003     * @param obj The icon object
3004     * @param scale_up A bool to set if the object is resizeable up. Default is
3005     * @c EINA_TRUE.
3006     * @param scale_down A bool to set if the object is resizeable down. Default
3007     * is @c EINA_TRUE.
3008     *
3009     * This function limits the icon object resize ability. If @p scale_up is set to
3010     * @c EINA_FALSE, the object can't have its height or width resized to a value
3011     * higher than the original icon size. Same is valid for @p scale_down.
3012     *
3013     * @see elm_icon_scale_get()
3014     *
3015     * @ingroup Icon
3016     */
3017    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3018    /**
3019     * Get if the object is (up/down) resizeable.
3020     *
3021     * @param obj The icon object
3022     * @param scale_up A bool to set if the object is resizeable up
3023     * @param scale_down A bool to set if the object is resizeable down
3024     *
3025     * @see elm_icon_scale_set()
3026     *
3027     * @ingroup Icon
3028     */
3029    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3030    /**
3031     * Get the object's image size
3032     *
3033     * @param obj The icon object
3034     * @param w A pointer to store the width in
3035     * @param h A pointer to store the height in
3036     *
3037     * @ingroup Icon
3038     */
3039    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3040    /**
3041     * Set if the icon fill the entire object area.
3042     *
3043     * @param obj The icon object
3044     * @param fill_outside @c EINA_TRUE if the object is filled outside,
3045     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3046     *
3047     * When the icon object is resized to a different aspect ratio from the
3048     * original icon image, the icon image will still keep its aspect. This flag
3049     * tells how the image should fill the object's area. They are: keep the
3050     * entire icon inside the limits of height and width of the object (@p
3051     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3052     * of the object, and the icon will fill the entire object (@p fill_outside
3053     * is @c EINA_TRUE).
3054     *
3055     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3056     * retain property to false. Thus, the icon image will always keep its
3057     * original aspect ratio.
3058     *
3059     * @see elm_icon_fill_outside_get()
3060     * @see elm_image_fill_outside_set()
3061     *
3062     * @ingroup Icon
3063     */
3064    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3065    /**
3066     * Get if the object is filled outside.
3067     *
3068     * @param obj The icon object
3069     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3070     *
3071     * @see elm_icon_fill_outside_set()
3072     *
3073     * @ingroup Icon
3074     */
3075    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3076    /**
3077     * Set the prescale size for the icon.
3078     *
3079     * @param obj The icon object
3080     * @param size The prescale size. This value is used for both width and
3081     * height.
3082     *
3083     * This function sets a new size for pixmap representation of the given
3084     * icon. It allows the icon to be loaded already in the specified size,
3085     * reducing the memory usage and load time when loading a big icon with load
3086     * size set to a smaller size.
3087     *
3088     * It's equivalent to the elm_bg_load_size_set() function for bg.
3089     *
3090     * @note this is just a hint, the real size of the pixmap may differ
3091     * depending on the type of icon being loaded, being bigger than requested.
3092     *
3093     * @see elm_icon_prescale_get()
3094     * @see elm_bg_load_size_set()
3095     *
3096     * @ingroup Icon
3097     */
3098    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3099    /**
3100     * Get the prescale size for the icon.
3101     *
3102     * @param obj The icon object
3103     * @return The prescale size
3104     *
3105     * @see elm_icon_prescale_set()
3106     *
3107     * @ingroup Icon
3108     */
3109    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3110    /**
3111     * Sets the icon lookup order used by elm_icon_standard_set().
3112     *
3113     * @param obj The icon object
3114     * @param order The icon lookup order (can be one of
3115     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3116     * or ELM_ICON_LOOKUP_THEME)
3117     *
3118     * @see elm_icon_order_lookup_get()
3119     * @see Elm_Icon_Lookup_Order
3120     *
3121     * @ingroup Icon
3122     */
3123    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3124    /**
3125     * Gets the icon lookup order.
3126     *
3127     * @param obj The icon object
3128     * @return The icon lookup order
3129     *
3130     * @see elm_icon_order_lookup_set()
3131     * @see Elm_Icon_Lookup_Order
3132     *
3133     * @ingroup Icon
3134     */
3135    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3136
3137    /**
3138     * @}
3139     */
3140
3141    /**
3142     * @defgroup Image Image
3143     *
3144     * @image html img/widget/image/preview-00.png
3145     * @image latex img/widget/image/preview-00.eps
3146     *
3147     * An object that allows one to load an image file to it. It can be used
3148     * anywhere like any other elementary widget.
3149     *
3150     * This widget provides most of the functionality provided from @ref Bg or @ref
3151     * Icon, but with a slightly different API (use the one that fits better your
3152     * needs).
3153     *
3154     * The features not provided by those two other image widgets are:
3155     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3156     * @li change the object orientation with elm_image_orient_set();
3157     * @li and turning the image editable with elm_image_editable_set().
3158     *
3159     * Signals that you can add callbacks for are:
3160     *
3161     * @li @c "clicked" - This is called when a user has clicked the image
3162     *
3163     * An example of usage for this API follows:
3164     * @li @ref tutorial_image
3165     */
3166
3167    /**
3168     * @addtogroup Image
3169     * @{
3170     */
3171
3172    /**
3173     * @enum _Elm_Image_Orient
3174     * @typedef Elm_Image_Orient
3175     *
3176     * Possible orientation options for elm_image_orient_set().
3177     *
3178     * @image html elm_image_orient_set.png
3179     * @image latex elm_image_orient_set.eps width=\textwidth
3180     *
3181     * @ingroup Image
3182     */
3183    typedef enum _Elm_Image_Orient
3184      {
3185         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3186         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3187         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3188         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3189         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3190         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3191         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3192         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3193      } Elm_Image_Orient;
3194
3195    /**
3196     * Add a new image to the parent.
3197     *
3198     * @param parent The parent object
3199     * @return The new object or NULL if it cannot be created
3200     *
3201     * @see elm_image_file_set()
3202     *
3203     * @ingroup Image
3204     */
3205    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3206    /**
3207     * Set the file that will be used as image.
3208     *
3209     * @param obj The image object
3210     * @param file The path to file that will be used as image
3211     * @param group The group that the image belongs in edje file (if it's an
3212     * edje image)
3213     *
3214     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3215     *
3216     * @see elm_image_file_get()
3217     *
3218     * @ingroup Image
3219     */
3220    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3221    /**
3222     * Get the file that will be used as image.
3223     *
3224     * @param obj The image object
3225     * @param file The path to file
3226     * @param group The group that the image belongs in edje file
3227     *
3228     * @see elm_image_file_set()
3229     *
3230     * @ingroup Image
3231     */
3232    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3233    /**
3234     * Set the smooth effect for an image.
3235     *
3236     * @param obj The image object
3237     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3238     * otherwise. Default is @c EINA_TRUE.
3239     *
3240     * Set the scaling algorithm to be used when scaling the image. Smooth
3241     * scaling provides a better resulting image, but is slower.
3242     *
3243     * The smooth scaling should be disabled when making animations that change
3244     * the image size, since it will be faster. Animations that don't require
3245     * resizing of the image can keep the smooth scaling enabled (even if the
3246     * image is already scaled, since the scaled image will be cached).
3247     *
3248     * @see elm_image_smooth_get()
3249     *
3250     * @ingroup Image
3251     */
3252    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3253    /**
3254     * Get the smooth effect for an image.
3255     *
3256     * @param obj The image object
3257     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3258     *
3259     * @see elm_image_smooth_get()
3260     *
3261     * @ingroup Image
3262     */
3263    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3264    /**
3265     * Gets the current size of the image.
3266     *
3267     * @param obj The image object.
3268     * @param w Pointer to store width, or NULL.
3269     * @param h Pointer to store height, or NULL.
3270     *
3271     * This is the real size of the image, not the size of the object.
3272     *
3273     * On error, neither w or h will be written.
3274     *
3275     * @ingroup Image
3276     */
3277    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3278    /**
3279     * Disable scaling of this object.
3280     *
3281     * @param obj The image object.
3282     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3283     * otherwise. Default is @c EINA_FALSE.
3284     *
3285     * This function disables scaling of the elm_image widget through the
3286     * function elm_object_scale_set(). However, this does not affect the widget
3287     * size/resize in any way. For that effect, take a look at
3288     * elm_image_scale_set().
3289     *
3290     * @see elm_image_no_scale_get()
3291     * @see elm_image_scale_set()
3292     * @see elm_object_scale_set()
3293     *
3294     * @ingroup Image
3295     */
3296    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3297    /**
3298     * Get whether scaling is disabled on the object.
3299     *
3300     * @param obj The image object
3301     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3302     *
3303     * @see elm_image_no_scale_set()
3304     *
3305     * @ingroup Image
3306     */
3307    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3308    /**
3309     * Set if the object is (up/down) resizeable.
3310     *
3311     * @param obj The image object
3312     * @param scale_up A bool to set if the object is resizeable up. Default is
3313     * @c EINA_TRUE.
3314     * @param scale_down A bool to set if the object is resizeable down. Default
3315     * is @c EINA_TRUE.
3316     *
3317     * This function limits the image resize ability. If @p scale_up is set to
3318     * @c EINA_FALSE, the object can't have its height or width resized to a value
3319     * higher than the original image size. Same is valid for @p scale_down.
3320     *
3321     * @see elm_image_scale_get()
3322     *
3323     * @ingroup Image
3324     */
3325    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3326    /**
3327     * Get if the object is (up/down) resizeable.
3328     *
3329     * @param obj The image object
3330     * @param scale_up A bool to set if the object is resizeable up
3331     * @param scale_down A bool to set if the object is resizeable down
3332     *
3333     * @see elm_image_scale_set()
3334     *
3335     * @ingroup Image
3336     */
3337    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3338    /**
3339     * Set if the image fill the entire object area when keeping the aspect ratio.
3340     *
3341     * @param obj The image object
3342     * @param fill_outside @c EINA_TRUE if the object is filled outside,
3343     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3344     *
3345     * When the image should keep its aspect ratio even if resized to another
3346     * aspect ratio, there are two possibilities to resize it: keep the entire
3347     * image inside the limits of height and width of the object (@p fill_outside
3348     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3349     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3350     *
3351     * @note This option will have no effect if
3352     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3353     *
3354     * @see elm_image_fill_outside_get()
3355     * @see elm_image_aspect_ratio_retained_set()
3356     *
3357     * @ingroup Image
3358     */
3359    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3360    /**
3361     * Get if the object is filled outside
3362     *
3363     * @param obj The image object
3364     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3365     *
3366     * @see elm_image_fill_outside_set()
3367     *
3368     * @ingroup Image
3369     */
3370    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3371    /**
3372     * Set the prescale size for the image
3373     *
3374     * @param obj The image object
3375     * @param size The prescale size. This value is used for both width and
3376     * height.
3377     *
3378     * This function sets a new size for pixmap representation of the given
3379     * image. It allows the image to be loaded already in the specified size,
3380     * reducing the memory usage and load time when loading a big image with load
3381     * size set to a smaller size.
3382     *
3383     * It's equivalent to the elm_bg_load_size_set() function for bg.
3384     *
3385     * @note this is just a hint, the real size of the pixmap may differ
3386     * depending on the type of image being loaded, being bigger than requested.
3387     *
3388     * @see elm_image_prescale_get()
3389     * @see elm_bg_load_size_set()
3390     *
3391     * @ingroup Image
3392     */
3393    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3394    /**
3395     * Get the prescale size for the image
3396     *
3397     * @param obj The image object
3398     * @return The prescale size
3399     *
3400     * @see elm_image_prescale_set()
3401     *
3402     * @ingroup Image
3403     */
3404    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3405    /**
3406     * Set the image orientation.
3407     *
3408     * @param obj The image object
3409     * @param orient The image orientation
3410     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3411     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3412     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3413     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3414     *  Default is #ELM_IMAGE_ORIENT_NONE.
3415     *
3416     * This function allows to rotate or flip the given image.
3417     *
3418     * @see elm_image_orient_get()
3419     * @see @ref Elm_Image_Orient
3420     *
3421     * @ingroup Image
3422     */
3423    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3424    /**
3425     * Get the image orientation.
3426     *
3427     * @param obj The image object
3428     * @return The image orientation
3429     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3430     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3431     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3432     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3433     *
3434     * @see elm_image_orient_set()
3435     * @see @ref Elm_Image_Orient
3436     *
3437     * @ingroup Image
3438     */
3439    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3440    /**
3441     * Make the image 'editable'.
3442     *
3443     * @param obj Image object.
3444     * @param set Turn on or off editability. Default is @c EINA_FALSE.
3445     *
3446     * This means the image is a valid drag target for drag and drop, and can be
3447     * cut or pasted too.
3448     *
3449     * @ingroup Image
3450     */
3451    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3452    /**
3453     * Make the image 'editable'.
3454     *
3455     * @param obj Image object.
3456     * @return Editability.
3457     *
3458     * This means the image is a valid drag target for drag and drop, and can be
3459     * cut or pasted too.
3460     *
3461     * @ingroup Image
3462     */
3463    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3464    /**
3465     * Get the basic Evas_Image object from this object (widget).
3466     *
3467     * @param obj The image object to get the inlined image from
3468     * @return The inlined image object, or NULL if none exists
3469     *
3470     * This function allows one to get the underlying @c Evas_Object of type
3471     * Image from this elementary widget. It can be useful to do things like get
3472     * the pixel data, save the image to a file, etc.
3473     *
3474     * @note Be careful to not manipulate it, as it is under control of
3475     * elementary.
3476     *
3477     * @ingroup Image
3478     */
3479    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3480    /**
3481     * Set whether the original aspect ratio of the image should be kept on resize.
3482     *
3483     * @param obj The image object.
3484     * @param retained @c EINA_TRUE if the image should retain the aspect,
3485     * @c EINA_FALSE otherwise.
3486     *
3487     * The original aspect ratio (width / height) of the image is usually
3488     * distorted to match the object's size. Enabling this option will retain
3489     * this original aspect, and the way that the image is fit into the object's
3490     * area depends on the option set by elm_image_fill_outside_set().
3491     *
3492     * @see elm_image_aspect_ratio_retained_get()
3493     * @see elm_image_fill_outside_set()
3494     *
3495     * @ingroup Image
3496     */
3497    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3498    /**
3499     * Get if the object retains the original aspect ratio.
3500     *
3501     * @param obj The image object.
3502     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3503     * otherwise.
3504     *
3505     * @ingroup Image
3506     */
3507    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3508
3509    /* smart callbacks called:
3510     * "clicked" - the user clicked the image
3511     */
3512
3513    /**
3514     * @}
3515     */
3516
3517    /* glview */
3518    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3519
3520    typedef enum _Elm_GLView_Mode
3521      {
3522         ELM_GLVIEW_ALPHA   = 1,
3523         ELM_GLVIEW_DEPTH   = 2,
3524         ELM_GLVIEW_STENCIL = 4
3525      } Elm_GLView_Mode;
3526
3527    /**
3528     * Defines a policy for the glview resizing.
3529     *
3530     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3531     */
3532    typedef enum _Elm_GLView_Resize_Policy
3533      {
3534         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
3535         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
3536      } Elm_GLView_Resize_Policy;
3537
3538    typedef enum _Elm_GLView_Render_Policy
3539      {
3540         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
3541         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
3542      } Elm_GLView_Render_Policy;
3543
3544
3545    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3546    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3547    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3548    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3549    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3550    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3551    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3552    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3553    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3554    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3555    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3556    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3557
3558    /* box */
3559    /**
3560     * @defgroup Box Box
3561     *
3562     * @image html img/widget/box/preview-00.png
3563     * @image latex img/widget/box/preview-00.eps width=\textwidth
3564     *
3565     * @image html img/box.png
3566     * @image latex img/box.eps width=\textwidth
3567     *
3568     * A box arranges objects in a linear fashion, governed by a layout function
3569     * that defines the details of this arrangement.
3570     *
3571     * By default, the box will use an internal function to set the layout to
3572     * a single row, either vertical or horizontal. This layout is affected
3573     * by a number of parameters, such as the homogeneous flag set by
3574     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3575     * elm_box_align_set() and the hints set to each object in the box.
3576     *
3577     * For this default layout, it's possible to change the orientation with
3578     * elm_box_horizontal_set(). The box will start in the vertical orientation,
3579     * placing its elements ordered from top to bottom. When horizontal is set,
3580     * the order will go from left to right. If the box is set to be
3581     * homogeneous, every object in it will be assigned the same space, that
3582     * of the largest object. Padding can be used to set some spacing between
3583     * the cell given to each object. The alignment of the box, set with
3584     * elm_box_align_set(), determines how the bounding box of all the elements
3585     * will be placed within the space given to the box widget itself.
3586     *
3587     * The size hints of each object also affect how they are placed and sized
3588     * within the box. evas_object_size_hint_min_set() will give the minimum
3589     * size the object can have, and the box will use it as the basis for all
3590     * latter calculations. Elementary widgets set their own minimum size as
3591     * needed, so there's rarely any need to use it manually.
3592     *
3593     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3594     * used to tell whether the object will be allocated the minimum size it
3595     * needs or if the space given to it should be expanded. It's important
3596     * to realize that expanding the size given to the object is not the same
3597     * thing as resizing the object. It could very well end being a small
3598     * widget floating in a much larger empty space. If not set, the weight
3599     * for objects will normally be 0.0 for both axis, meaning the widget will
3600     * not be expanded. To take as much space possible, set the weight to
3601     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3602     *
3603     * Besides how much space each object is allocated, it's possible to control
3604     * how the widget will be placed within that space using
3605     * evas_object_size_hint_align_set(). By default, this value will be 0.5
3606     * for both axis, meaning the object will be centered, but any value from
3607     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3608     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3609     * is -1.0, means the object will be resized to fill the entire space it
3610     * was allocated.
3611     *
3612     * In addition, customized functions to define the layout can be set, which
3613     * allow the application developer to organize the objects within the box
3614     * in any number of ways.
3615     *
3616     * The special elm_box_layout_transition() function can be used
3617     * to switch from one layout to another, animating the motion of the
3618     * children of the box.
3619     *
3620     * @note Objects should not be added to box objects using _add() calls.
3621     *
3622     * Some examples on how to use boxes follow:
3623     * @li @ref box_example_01
3624     * @li @ref box_example_02
3625     *
3626     * @{
3627     */
3628    /**
3629     * @typedef Elm_Box_Transition
3630     *
3631     * Opaque handler containing the parameters to perform an animated
3632     * transition of the layout the box uses.
3633     *
3634     * @see elm_box_transition_new()
3635     * @see elm_box_layout_set()
3636     * @see elm_box_layout_transition()
3637     */
3638    typedef struct _Elm_Box_Transition Elm_Box_Transition;
3639
3640    /**
3641     * Add a new box to the parent
3642     *
3643     * By default, the box will be in vertical mode and non-homogeneous.
3644     *
3645     * @param parent The parent object
3646     * @return The new object or NULL if it cannot be created
3647     */
3648    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3649    /**
3650     * Set the horizontal orientation
3651     *
3652     * By default, box object arranges their contents vertically from top to
3653     * bottom.
3654     * By calling this function with @p horizontal as EINA_TRUE, the box will
3655     * become horizontal, arranging contents from left to right.
3656     *
3657     * @note This flag is ignored if a custom layout function is set.
3658     *
3659     * @param obj The box object
3660     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3661     * EINA_FALSE = vertical)
3662     */
3663    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3664    /**
3665     * Get the horizontal orientation
3666     *
3667     * @param obj The box object
3668     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3669     */
3670    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3671    /**
3672     * Set the box to arrange its children homogeneously
3673     *
3674     * If enabled, homogeneous layout makes all items the same size, according
3675     * to the size of the largest of its children.
3676     *
3677     * @note This flag is ignored if a custom layout function is set.
3678     *
3679     * @param obj The box object
3680     * @param homogeneous The homogeneous flag
3681     */
3682    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3683    /**
3684     * Get whether the box is using homogeneous mode or not
3685     *
3686     * @param obj The box object
3687     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3688     */
3689    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3690    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3691    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3692    /**
3693     * Add an object to the beginning of the pack list
3694     *
3695     * Pack @p subobj into the box @p obj, placing it first in the list of
3696     * children objects. The actual position the object will get on screen
3697     * depends on the layout used. If no custom layout is set, it will be at
3698     * the top or left, depending if the box is vertical or horizontal,
3699     * respectively.
3700     *
3701     * @param obj The box object
3702     * @param subobj The object to add to the box
3703     *
3704     * @see elm_box_pack_end()
3705     * @see elm_box_pack_before()
3706     * @see elm_box_pack_after()
3707     * @see elm_box_unpack()
3708     * @see elm_box_unpack_all()
3709     * @see elm_box_clear()
3710     */
3711    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3712    /**
3713     * Add an object at the end of the pack list
3714     *
3715     * Pack @p subobj into the box @p obj, placing it last in the list of
3716     * children objects. The actual position the object will get on screen
3717     * depends on the layout used. If no custom layout is set, it will be at
3718     * the bottom or right, depending if the box is vertical or horizontal,
3719     * respectively.
3720     *
3721     * @param obj The box object
3722     * @param subobj The object to add to the box
3723     *
3724     * @see elm_box_pack_start()
3725     * @see elm_box_pack_before()
3726     * @see elm_box_pack_after()
3727     * @see elm_box_unpack()
3728     * @see elm_box_unpack_all()
3729     * @see elm_box_clear()
3730     */
3731    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3732    /**
3733     * Adds an object to the box before the indicated object
3734     *
3735     * This will add the @p subobj to the box indicated before the object
3736     * indicated with @p before. If @p before is not already in the box, results
3737     * are undefined. Before means either to the left of the indicated object or
3738     * above it depending on orientation.
3739     *
3740     * @param obj The box object
3741     * @param subobj The object to add to the box
3742     * @param before The object before which to add it
3743     *
3744     * @see elm_box_pack_start()
3745     * @see elm_box_pack_end()
3746     * @see elm_box_pack_after()
3747     * @see elm_box_unpack()
3748     * @see elm_box_unpack_all()
3749     * @see elm_box_clear()
3750     */
3751    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3752    /**
3753     * Adds an object to the box after the indicated object
3754     *
3755     * This will add the @p subobj to the box indicated after the object
3756     * indicated with @p after. If @p after is not already in the box, results
3757     * are undefined. After means either to the right of the indicated object or
3758     * below it depending on orientation.
3759     *
3760     * @param obj The box object
3761     * @param subobj The object to add to the box
3762     * @param after The object after which to add it
3763     *
3764     * @see elm_box_pack_start()
3765     * @see elm_box_pack_end()
3766     * @see elm_box_pack_before()
3767     * @see elm_box_unpack()
3768     * @see elm_box_unpack_all()
3769     * @see elm_box_clear()
3770     */
3771    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3772    /**
3773     * Clear the box of all children
3774     *
3775     * Remove all the elements contained by the box, deleting the respective
3776     * objects.
3777     *
3778     * @param obj The box object
3779     *
3780     * @see elm_box_unpack()
3781     * @see elm_box_unpack_all()
3782     */
3783    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3784    /**
3785     * Unpack a box item
3786     *
3787     * Remove the object given by @p subobj from the box @p obj without
3788     * deleting it.
3789     *
3790     * @param obj The box object
3791     *
3792     * @see elm_box_unpack_all()
3793     * @see elm_box_clear()
3794     */
3795    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3796    /**
3797     * Remove all items from the box, without deleting them
3798     *
3799     * Clear the box from all children, but don't delete the respective objects.
3800     * If no other references of the box children exist, the objects will never
3801     * be deleted, and thus the application will leak the memory. Make sure
3802     * when using this function that you hold a reference to all the objects
3803     * in the box @p obj.
3804     *
3805     * @param obj The box object
3806     *
3807     * @see elm_box_clear()
3808     * @see elm_box_unpack()
3809     */
3810    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3811    /**
3812     * Retrieve a list of the objects packed into the box
3813     *
3814     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3815     * The order of the list corresponds to the packing order the box uses.
3816     *
3817     * You must free this list with eina_list_free() once you are done with it.
3818     *
3819     * @param obj The box object
3820     */
3821    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3822    /**
3823     * Set the space (padding) between the box's elements.
3824     *
3825     * Extra space in pixels that will be added between a box child and its
3826     * neighbors after its containing cell has been calculated. This padding
3827     * is set for all elements in the box, besides any possible padding that
3828     * individual elements may have through their size hints.
3829     *
3830     * @param obj The box object
3831     * @param horizontal The horizontal space between elements
3832     * @param vertical The vertical space between elements
3833     */
3834    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3835    /**
3836     * Get the space (padding) between the box's elements.
3837     *
3838     * @param obj The box object
3839     * @param horizontal The horizontal space between elements
3840     * @param vertical The vertical space between elements
3841     *
3842     * @see elm_box_padding_set()
3843     */
3844    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3845    /**
3846     * Set the alignment of the whole bouding box of contents.
3847     *
3848     * Sets how the bounding box containing all the elements of the box, after
3849     * their sizes and position has been calculated, will be aligned within
3850     * the space given for the whole box widget.
3851     *
3852     * @param obj The box object
3853     * @param horizontal The horizontal alignment of elements
3854     * @param vertical The vertical alignment of elements
3855     */
3856    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
3857    /**
3858     * Get the alignment of the whole bouding box of contents.
3859     *
3860     * @param obj The box object
3861     * @param horizontal The horizontal alignment of elements
3862     * @param vertical The vertical alignment of elements
3863     *
3864     * @see elm_box_align_set()
3865     */
3866    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
3867
3868    /**
3869     * Set the layout defining function to be used by the box
3870     *
3871     * Whenever anything changes that requires the box in @p obj to recalculate
3872     * the size and position of its elements, the function @p cb will be called
3873     * to determine what the layout of the children will be.
3874     *
3875     * Once a custom function is set, everything about the children layout
3876     * is defined by it. The flags set by elm_box_horizontal_set() and
3877     * elm_box_homogeneous_set() no longer have any meaning, and the values
3878     * given by elm_box_padding_set() and elm_box_align_set() are up to this
3879     * layout function to decide if they are used and how. These last two
3880     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
3881     * passed to @p cb. The @c Evas_Object the function receives is not the
3882     * Elementary widget, but the internal Evas Box it uses, so none of the
3883     * functions described here can be used on it.
3884     *
3885     * Any of the layout functions in @c Evas can be used here, as well as the
3886     * special elm_box_layout_transition().
3887     *
3888     * The final @p data argument received by @p cb is the same @p data passed
3889     * here, and the @p free_data function will be called to free it
3890     * whenever the box is destroyed or another layout function is set.
3891     *
3892     * Setting @p cb to NULL will revert back to the default layout function.
3893     *
3894     * @param obj The box object
3895     * @param cb The callback function used for layout
3896     * @param data Data that will be passed to layout function
3897     * @param free_data Function called to free @p data
3898     *
3899     * @see elm_box_layout_transition()
3900     */
3901    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);
3902    /**
3903     * Special layout function that animates the transition from one layout to another
3904     *
3905     * Normally, when switching the layout function for a box, this will be
3906     * reflected immediately on screen on the next render, but it's also
3907     * possible to do this through an animated transition.
3908     *
3909     * This is done by creating an ::Elm_Box_Transition and setting the box
3910     * layout to this function.
3911     *
3912     * For example:
3913     * @code
3914     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
3915     *                            evas_object_box_layout_vertical, // start
3916     *                            NULL, // data for initial layout
3917     *                            NULL, // free function for initial data
3918     *                            evas_object_box_layout_horizontal, // end
3919     *                            NULL, // data for final layout
3920     *                            NULL, // free function for final data
3921     *                            anim_end, // will be called when animation ends
3922     *                            NULL); // data for anim_end function\
3923     * elm_box_layout_set(box, elm_box_layout_transition, t,
3924     *                    elm_box_transition_free);
3925     * @endcode
3926     *
3927     * @note This function can only be used with elm_box_layout_set(). Calling
3928     * it directly will not have the expected results.
3929     *
3930     * @see elm_box_transition_new
3931     * @see elm_box_transition_free
3932     * @see elm_box_layout_set
3933     */
3934    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3935    /**
3936     * Create a new ::Elm_Box_Transition to animate the switch of layouts
3937     *
3938     * If you want to animate the change from one layout to another, you need
3939     * to set the layout function of the box to elm_box_layout_transition(),
3940     * passing as user data to it an instance of ::Elm_Box_Transition with the
3941     * necessary information to perform this animation. The free function to
3942     * set for the layout is elm_box_transition_free().
3943     *
3944     * The parameters to create an ::Elm_Box_Transition sum up to how long
3945     * will it be, in seconds, a layout function to describe the initial point,
3946     * another for the final position of the children and one function to be
3947     * called when the whole animation ends. This last function is useful to
3948     * set the definitive layout for the box, usually the same as the end
3949     * layout for the animation, but could be used to start another transition.
3950     *
3951     * @param start_layout The layout function that will be used to start the animation
3952     * @param start_layout_data The data to be passed the @p start_layout function
3953     * @param start_layout_free_data Function to free @p start_layout_data
3954     * @param end_layout The layout function that will be used to end the animation
3955     * @param end_layout_free_data The data to be passed the @p end_layout function
3956     * @param end_layout_free_data Function to free @p end_layout_data
3957     * @param transition_end_cb Callback function called when animation ends
3958     * @param transition_end_data Data to be passed to @p transition_end_cb
3959     * @return An instance of ::Elm_Box_Transition
3960     *
3961     * @see elm_box_transition_new
3962     * @see elm_box_layout_transition
3963     */
3964    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);
3965    /**
3966     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3967     *
3968     * This function is mostly useful as the @c free_data parameter in
3969     * elm_box_layout_set() when elm_box_layout_transition().
3970     *
3971     * @param data The Elm_Box_Transition instance to be freed.
3972     *
3973     * @see elm_box_transition_new
3974     * @see elm_box_layout_transition
3975     */
3976    EAPI void                elm_box_transition_free(void *data);
3977    /**
3978     * @}
3979     */
3980
3981    /* button */
3982    /**
3983     * @defgroup Button Button
3984     *
3985     * @image html img/widget/button/preview-00.png
3986     * @image html img/widget/button/preview-01.png
3987     * @image html img/widget/button/preview-02.png
3988     *
3989     * This is a push-button. Press it and run some function. It can contain
3990     * a simple label and icon object and it also has an autorepeat feature.
3991     *
3992     * This widgets emits the following signals:
3993     * @li "clicked": the user clicked the button (press/release).
3994     * @li "repeated": the user pressed the button without releasing it.
3995     * @li "pressed": button was pressed.
3996     * @li "unpressed": button was released after being pressed.
3997     * In all three cases, the @c event parameter of the callback will be
3998     * @c NULL.
3999     *
4000     * Also, defined in the default theme, the button has the following styles
4001     * available:
4002     * @li default: a normal button.
4003     * @li anchor: Like default, but the button fades away when the mouse is not
4004     * over it, leaving only the text or icon.
4005     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4006     * continuous look across its options.
4007     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4008     *
4009     * Follow through a complete example @ref button_example_01 "here".
4010     * @{
4011     */
4012    /**
4013     * Add a new button to the parent's canvas
4014     *
4015     * @param parent The parent object
4016     * @return The new object or NULL if it cannot be created
4017     */
4018    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4019    /**
4020     * Set the label used in the button
4021     *
4022     * The passed @p label can be NULL to clean any existing text in it and
4023     * leave the button as an icon only object.
4024     *
4025     * @param obj The button object
4026     * @param label The text will be written on the button
4027     * @deprecated use elm_object_text_set() instead.
4028     */
4029    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4030    /**
4031     * Get the label set for the button
4032     *
4033     * The string returned is an internal pointer and should not be freed or
4034     * altered. It will also become invalid when the button is destroyed.
4035     * The string returned, if not NULL, is a stringshare, so if you need to
4036     * keep it around even after the button is destroyed, you can use
4037     * eina_stringshare_ref().
4038     *
4039     * @param obj The button object
4040     * @return The text set to the label, or NULL if nothing is set
4041     * @deprecated use elm_object_text_set() instead.
4042     */
4043    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4044    /**
4045     * Set the icon used for the button
4046     *
4047     * Setting a new icon will delete any other that was previously set, making
4048     * any reference to them invalid. If you need to maintain the previous
4049     * object alive, unset it first with elm_button_icon_unset().
4050     *
4051     * @param obj The button object
4052     * @param icon The icon object for the button
4053     */
4054    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4055    /**
4056     * Get the icon used for the button
4057     *
4058     * Return the icon object which is set for this widget. If the button is
4059     * destroyed or another icon is set, the returned object will be deleted
4060     * and any reference to it will be invalid.
4061     *
4062     * @param obj The button object
4063     * @return The icon object that is being used
4064     *
4065     * @see elm_button_icon_unset()
4066     */
4067    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4068    /**
4069     * Remove the icon set without deleting it and return the object
4070     *
4071     * This function drops the reference the button holds of the icon object
4072     * and returns this last object. It is used in case you want to remove any
4073     * icon, or set another one, without deleting the actual object. The button
4074     * will be left without an icon set.
4075     *
4076     * @param obj The button object
4077     * @return The icon object that was being used
4078     */
4079    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4080    /**
4081     * Turn on/off the autorepeat event generated when the button is kept pressed
4082     *
4083     * When off, no autorepeat is performed and buttons emit a normal @c clicked
4084     * signal when they are clicked.
4085     *
4086     * When on, keeping a button pressed will continuously emit a @c repeated
4087     * signal until the button is released. The time it takes until it starts
4088     * emitting the signal is given by
4089     * elm_button_autorepeat_initial_timeout_set(), and the time between each
4090     * new emission by elm_button_autorepeat_gap_timeout_set().
4091     *
4092     * @param obj The button object
4093     * @param on  A bool to turn on/off the event
4094     */
4095    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4096    /**
4097     * Get whether the autorepeat feature is enabled
4098     *
4099     * @param obj The button object
4100     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4101     *
4102     * @see elm_button_autorepeat_set()
4103     */
4104    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4105    /**
4106     * Set the initial timeout before the autorepeat event is generated
4107     *
4108     * Sets the timeout, in seconds, since the button is pressed until the
4109     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4110     * won't be any delay and the even will be fired the moment the button is
4111     * pressed.
4112     *
4113     * @param obj The button object
4114     * @param t   Timeout in seconds
4115     *
4116     * @see elm_button_autorepeat_set()
4117     * @see elm_button_autorepeat_gap_timeout_set()
4118     */
4119    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4120    /**
4121     * Get the initial timeout before the autorepeat event is generated
4122     *
4123     * @param obj The button object
4124     * @return Timeout in seconds
4125     *
4126     * @see elm_button_autorepeat_initial_timeout_set()
4127     */
4128    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4129    /**
4130     * Set the interval between each generated autorepeat event
4131     *
4132     * After the first @c repeated event is fired, all subsequent ones will
4133     * follow after a delay of @p t seconds for each.
4134     *
4135     * @param obj The button object
4136     * @param t   Interval in seconds
4137     *
4138     * @see elm_button_autorepeat_initial_timeout_set()
4139     */
4140    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4141    /**
4142     * Get the interval between each generated autorepeat event
4143     *
4144     * @param obj The button object
4145     * @return Interval in seconds
4146     */
4147    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4148    /**
4149     * @}
4150     */
4151
4152    /**
4153     * @defgroup File_Selector_Button File Selector Button
4154     *
4155     * @image html img/widget/fileselector_button/preview-00.png
4156     * @image html img/widget/fileselector_button/preview-01.png
4157     * @image html img/widget/fileselector_button/preview-02.png
4158     *
4159     * This is a button that, when clicked, creates an Elementary
4160     * window (or inner window) <b> with a @ref Fileselector "file
4161     * selector widget" within</b>. When a file is chosen, the (inner)
4162     * window is closed and the button emits a signal having the
4163     * selected file as it's @c event_info.
4164     *
4165     * This widget encapsulates operations on its internal file
4166     * selector on its own API. There is less control over its file
4167     * selector than that one would have instatiating one directly.
4168     *
4169     * The following styles are available for this button:
4170     * @li @c "default"
4171     * @li @c "anchor"
4172     * @li @c "hoversel_vertical"
4173     * @li @c "hoversel_vertical_entry"
4174     *
4175     * Smart callbacks one can register to:
4176     * - @c "file,chosen" - the user has selected a path, whose string
4177     *   pointer comes as the @c event_info data (a stringshared
4178     *   string)
4179     *
4180     * Here is an example on its usage:
4181     * @li @ref fileselector_button_example
4182     *
4183     * @see @ref File_Selector_Entry for a similar widget.
4184     * @{
4185     */
4186
4187    /**
4188     * Add a new file selector button widget to the given parent
4189     * Elementary (container) object
4190     *
4191     * @param parent The parent object
4192     * @return a new file selector button widget handle or @c NULL, on
4193     * errors
4194     */
4195    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4196
4197    /**
4198     * Set the label for a given file selector button widget
4199     *
4200     * @param obj The file selector button widget
4201     * @param label The text label to be displayed on @p obj
4202     *
4203     * @deprecated use elm_object_text_set() instead.
4204     */
4205    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4206
4207    /**
4208     * Get the label set for a given file selector button widget
4209     *
4210     * @param obj The file selector button widget
4211     * @return The button label
4212     *
4213     * @deprecated use elm_object_text_set() instead.
4214     */
4215    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4216
4217    /**
4218     * Set the icon on a given file selector button widget
4219     *
4220     * @param obj The file selector button widget
4221     * @param icon The icon object for the button
4222     *
4223     * Once the icon object is set, a previously set one will be
4224     * deleted. If you want to keep the latter, use the
4225     * elm_fileselector_button_icon_unset() function.
4226     *
4227     * @see elm_fileselector_button_icon_get()
4228     */
4229    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4230
4231    /**
4232     * Get the icon set for a given file selector button widget
4233     *
4234     * @param obj The file selector button widget
4235     * @return The icon object currently set on @p obj or @c NULL, if
4236     * none is
4237     *
4238     * @see elm_fileselector_button_icon_set()
4239     */
4240    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4241
4242    /**
4243     * Unset the icon used in a given file selector button widget
4244     *
4245     * @param obj The file selector button widget
4246     * @return The icon object that was being used on @p obj or @c
4247     * NULL, on errors
4248     *
4249     * Unparent and return the icon object which was set for this
4250     * widget.
4251     *
4252     * @see elm_fileselector_button_icon_set()
4253     */
4254    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4255
4256    /**
4257     * Set the title for a given file selector button widget's window
4258     *
4259     * @param obj The file selector button widget
4260     * @param title The title string
4261     *
4262     * This will change the window's title, when the file selector pops
4263     * out after a click on the button. Those windows have the default
4264     * (unlocalized) value of @c "Select a file" as titles.
4265     *
4266     * @note It will only take any effect if the file selector
4267     * button widget is @b not under "inwin mode".
4268     *
4269     * @see elm_fileselector_button_window_title_get()
4270     */
4271    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4272
4273    /**
4274     * Get the title set for a given file selector button widget's
4275     * window
4276     *
4277     * @param obj The file selector button widget
4278     * @return Title of the file selector button's window
4279     *
4280     * @see elm_fileselector_button_window_title_get() for more details
4281     */
4282    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4283
4284    /**
4285     * Set the size of a given file selector button widget's window,
4286     * holding the file selector itself.
4287     *
4288     * @param obj The file selector button widget
4289     * @param width The window's width
4290     * @param height The window's height
4291     *
4292     * @note it will only take any effect if the file selector button
4293     * widget is @b not under "inwin mode". The default size for the
4294     * window (when applicable) is 400x400 pixels.
4295     *
4296     * @see elm_fileselector_button_window_size_get()
4297     */
4298    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4299
4300    /**
4301     * Get the size of a given file selector button widget's window,
4302     * holding the file selector itself.
4303     *
4304     * @param obj The file selector button widget
4305     * @param width Pointer into which to store the width value
4306     * @param height Pointer into which to store the height value
4307     *
4308     * @note Use @c NULL pointers on the size values you're not
4309     * interested in: they'll be ignored by the function.
4310     *
4311     * @see elm_fileselector_button_window_size_set(), for more details
4312     */
4313    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4314
4315    /**
4316     * Set the initial file system path for a given file selector
4317     * button widget
4318     *
4319     * @param obj The file selector button widget
4320     * @param path The path string
4321     *
4322     * It must be a <b>directory</b> path, which will have the contents
4323     * displayed initially in the file selector's view, when invoked
4324     * from @p obj. The default initial path is the @c "HOME"
4325     * environment variable's value.
4326     *
4327     * @see elm_fileselector_button_path_get()
4328     */
4329    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4330
4331    /**
4332     * Get the initial file system path set for a given file selector
4333     * button widget
4334     *
4335     * @param obj The file selector button widget
4336     * @return path The path string
4337     *
4338     * @see elm_fileselector_button_path_set() for more details
4339     */
4340    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4341
4342    /**
4343     * Enable/disable a tree view in the given file selector button
4344     * widget's internal file selector
4345     *
4346     * @param obj The file selector button widget
4347     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4348     * disable
4349     *
4350     * This has the same effect as elm_fileselector_expandable_set(),
4351     * but now applied to a file selector button's internal file
4352     * selector.
4353     *
4354     * @note There's no way to put a file selector button's internal
4355     * file selector in "grid mode", as one may do with "pure" file
4356     * selectors.
4357     *
4358     * @see elm_fileselector_expandable_get()
4359     */
4360    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4361
4362    /**
4363     * Get whether tree view is enabled for the given file selector
4364     * button widget's internal file selector
4365     *
4366     * @param obj The file selector button widget
4367     * @return @c EINA_TRUE if @p obj widget's internal file selector
4368     * is in tree view, @c EINA_FALSE otherwise (and or errors)
4369     *
4370     * @see elm_fileselector_expandable_set() for more details
4371     */
4372    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4373
4374    /**
4375     * Set whether a given file selector button widget's internal file
4376     * selector is to display folders only or the directory contents,
4377     * as well.
4378     *
4379     * @param obj The file selector button widget
4380     * @param only @c EINA_TRUE to make @p obj widget's internal file
4381     * selector only display directories, @c EINA_FALSE to make files
4382     * to be displayed in it too
4383     *
4384     * This has the same effect as elm_fileselector_folder_only_set(),
4385     * but now applied to a file selector button's internal file
4386     * selector.
4387     *
4388     * @see elm_fileselector_folder_only_get()
4389     */
4390    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4391
4392    /**
4393     * Get whether a given file selector button widget's internal file
4394     * selector is displaying folders only or the directory contents,
4395     * as well.
4396     *
4397     * @param obj The file selector button widget
4398     * @return @c EINA_TRUE if @p obj widget's internal file
4399     * selector is only displaying directories, @c EINA_FALSE if files
4400     * are being displayed in it too (and on errors)
4401     *
4402     * @see elm_fileselector_button_folder_only_set() for more details
4403     */
4404    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4405
4406    /**
4407     * Enable/disable the file name entry box where the user can type
4408     * in a name for a file, in a given file selector button widget's
4409     * internal file selector.
4410     *
4411     * @param obj The file selector button widget
4412     * @param is_save @c EINA_TRUE to make @p obj widget's internal
4413     * file selector a "saving dialog", @c EINA_FALSE otherwise
4414     *
4415     * This has the same effect as elm_fileselector_is_save_set(),
4416     * but now applied to a file selector button's internal file
4417     * selector.
4418     *
4419     * @see elm_fileselector_is_save_get()
4420     */
4421    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4422
4423    /**
4424     * Get whether the given file selector button widget's internal
4425     * file selector is in "saving dialog" mode
4426     *
4427     * @param obj The file selector button widget
4428     * @return @c EINA_TRUE, if @p obj widget's internal file selector
4429     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4430     * errors)
4431     *
4432     * @see elm_fileselector_button_is_save_set() for more details
4433     */
4434    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4435
4436    /**
4437     * Set whether a given file selector button widget's internal file
4438     * selector will raise an Elementary "inner window", instead of a
4439     * dedicated Elementary window. By default, it won't.
4440     *
4441     * @param obj The file selector button widget
4442     * @param value @c EINA_TRUE to make it use an inner window, @c
4443     * EINA_TRUE to make it use a dedicated window
4444     *
4445     * @see elm_win_inwin_add() for more information on inner windows
4446     * @see elm_fileselector_button_inwin_mode_get()
4447     */
4448    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4449
4450    /**
4451     * Get whether a given file selector button widget's internal file
4452     * selector will raise an Elementary "inner window", instead of a
4453     * dedicated Elementary window.
4454     *
4455     * @param obj The file selector button widget
4456     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4457     * if it will use a dedicated window
4458     *
4459     * @see elm_fileselector_button_inwin_mode_set() for more details
4460     */
4461    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4462
4463    /**
4464     * @}
4465     */
4466
4467     /**
4468     * @defgroup File_Selector_Entry File Selector Entry
4469     *
4470     * @image html img/widget/fileselector_entry/preview-00.png
4471     * @image latex img/widget/fileselector_entry/preview-00.eps
4472     *
4473     * This is an entry made to be filled with or display a <b>file
4474     * system path string</b>. Besides the entry itself, the widget has
4475     * a @ref File_Selector_Button "file selector button" on its side,
4476     * which will raise an internal @ref Fileselector "file selector widget",
4477     * when clicked, for path selection aided by file system
4478     * navigation.
4479     *
4480     * This file selector may appear in an Elementary window or in an
4481     * inner window. When a file is chosen from it, the (inner) window
4482     * is closed and the selected file's path string is exposed both as
4483     * an smart event and as the new text on the entry.
4484     *
4485     * This widget encapsulates operations on its internal file
4486     * selector on its own API. There is less control over its file
4487     * selector than that one would have instatiating one directly.
4488     *
4489     * Smart callbacks one can register to:
4490     * - @c "changed" - The text within the entry was changed
4491     * - @c "activated" - The entry has had editing finished and
4492     *   changes are to be "committed"
4493     * - @c "press" - The entry has been clicked
4494     * - @c "longpressed" - The entry has been clicked (and held) for a
4495     *   couple seconds
4496     * - @c "clicked" - The entry has been clicked
4497     * - @c "clicked,double" - The entry has been double clicked
4498     * - @c "focused" - The entry has received focus
4499     * - @c "unfocused" - The entry has lost focus
4500     * - @c "selection,paste" - A paste action has occurred on the
4501     *   entry
4502     * - @c "selection,copy" - A copy action has occurred on the entry
4503     * - @c "selection,cut" - A cut action has occurred on the entry
4504     * - @c "unpressed" - The file selector entry's button was released
4505     *   after being pressed.
4506     * - @c "file,chosen" - The user has selected a path via the file
4507     *   selector entry's internal file selector, whose string pointer
4508     *   comes as the @c event_info data (a stringshared string)
4509     *
4510     * Here is an example on its usage:
4511     * @li @ref fileselector_entry_example
4512     *
4513     * @see @ref File_Selector_Button for a similar widget.
4514     * @{
4515     */
4516
4517    /**
4518     * Add a new file selector entry widget to the given parent
4519     * Elementary (container) object
4520     *
4521     * @param parent The parent object
4522     * @return a new file selector entry widget handle or @c NULL, on
4523     * errors
4524     */
4525    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4526
4527    /**
4528     * Set the label for a given file selector entry widget's button
4529     *
4530     * @param obj The file selector entry widget
4531     * @param label The text label to be displayed on @p obj widget's
4532     * button
4533     *
4534     * @deprecated use elm_object_text_set() instead.
4535     */
4536    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4537
4538    /**
4539     * Get the label set for a given file selector entry widget's button
4540     *
4541     * @param obj The file selector entry widget
4542     * @return The widget button's label
4543     *
4544     * @deprecated use elm_object_text_set() instead.
4545     */
4546    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4547
4548    /**
4549     * Set the icon on a given file selector entry widget's button
4550     *
4551     * @param obj The file selector entry widget
4552     * @param icon The icon object for the entry's button
4553     *
4554     * Once the icon object is set, a previously set one will be
4555     * deleted. If you want to keep the latter, use the
4556     * elm_fileselector_entry_button_icon_unset() function.
4557     *
4558     * @see elm_fileselector_entry_button_icon_get()
4559     */
4560    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4561
4562    /**
4563     * Get the icon set for a given file selector entry widget's button
4564     *
4565     * @param obj The file selector entry widget
4566     * @return The icon object currently set on @p obj widget's button
4567     * or @c NULL, if none is
4568     *
4569     * @see elm_fileselector_entry_button_icon_set()
4570     */
4571    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4572
4573    /**
4574     * Unset the icon used in a given file selector entry widget's
4575     * button
4576     *
4577     * @param obj The file selector entry widget
4578     * @return The icon object that was being used on @p obj widget's
4579     * button or @c NULL, on errors
4580     *
4581     * Unparent and return the icon object which was set for this
4582     * widget's button.
4583     *
4584     * @see elm_fileselector_entry_button_icon_set()
4585     */
4586    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4587
4588    /**
4589     * Set the title for a given file selector entry widget's window
4590     *
4591     * @param obj The file selector entry widget
4592     * @param title The title string
4593     *
4594     * This will change the window's title, when the file selector pops
4595     * out after a click on the entry's button. Those windows have the
4596     * default (unlocalized) value of @c "Select a file" as titles.
4597     *
4598     * @note It will only take any effect if the file selector
4599     * entry widget is @b not under "inwin mode".
4600     *
4601     * @see elm_fileselector_entry_window_title_get()
4602     */
4603    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4604
4605    /**
4606     * Get the title set for a given file selector entry widget's
4607     * window
4608     *
4609     * @param obj The file selector entry widget
4610     * @return Title of the file selector entry's window
4611     *
4612     * @see elm_fileselector_entry_window_title_get() for more details
4613     */
4614    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4615
4616    /**
4617     * Set the size of a given file selector entry widget's window,
4618     * holding the file selector itself.
4619     *
4620     * @param obj The file selector entry widget
4621     * @param width The window's width
4622     * @param height The window's height
4623     *
4624     * @note it will only take any effect if the file selector entry
4625     * widget is @b not under "inwin mode". The default size for the
4626     * window (when applicable) is 400x400 pixels.
4627     *
4628     * @see elm_fileselector_entry_window_size_get()
4629     */
4630    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4631
4632    /**
4633     * Get the size of a given file selector entry widget's window,
4634     * holding the file selector itself.
4635     *
4636     * @param obj The file selector entry widget
4637     * @param width Pointer into which to store the width value
4638     * @param height Pointer into which to store the height value
4639     *
4640     * @note Use @c NULL pointers on the size values you're not
4641     * interested in: they'll be ignored by the function.
4642     *
4643     * @see elm_fileselector_entry_window_size_set(), for more details
4644     */
4645    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4646
4647    /**
4648     * Set the initial file system path and the entry's path string for
4649     * a given file selector entry widget
4650     *
4651     * @param obj The file selector entry widget
4652     * @param path The path string
4653     *
4654     * It must be a <b>directory</b> path, which will have the contents
4655     * displayed initially in the file selector's view, when invoked
4656     * from @p obj. The default initial path is the @c "HOME"
4657     * environment variable's value.
4658     *
4659     * @see elm_fileselector_entry_path_get()
4660     */
4661    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4662
4663    /**
4664     * Get the entry's path string for a given file selector entry
4665     * widget
4666     *
4667     * @param obj The file selector entry widget
4668     * @return path The path string
4669     *
4670     * @see elm_fileselector_entry_path_set() for more details
4671     */
4672    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4673
4674    /**
4675     * Enable/disable a tree view in the given file selector entry
4676     * widget's internal file selector
4677     *
4678     * @param obj The file selector entry widget
4679     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4680     * disable
4681     *
4682     * This has the same effect as elm_fileselector_expandable_set(),
4683     * but now applied to a file selector entry's internal file
4684     * selector.
4685     *
4686     * @note There's no way to put a file selector entry's internal
4687     * file selector in "grid mode", as one may do with "pure" file
4688     * selectors.
4689     *
4690     * @see elm_fileselector_expandable_get()
4691     */
4692    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4693
4694    /**
4695     * Get whether tree view is enabled for the given file selector
4696     * entry widget's internal file selector
4697     *
4698     * @param obj The file selector entry widget
4699     * @return @c EINA_TRUE if @p obj widget's internal file selector
4700     * is in tree view, @c EINA_FALSE otherwise (and or errors)
4701     *
4702     * @see elm_fileselector_expandable_set() for more details
4703     */
4704    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4705
4706    /**
4707     * Set whether a given file selector entry widget's internal file
4708     * selector is to display folders only or the directory contents,
4709     * as well.
4710     *
4711     * @param obj The file selector entry widget
4712     * @param only @c EINA_TRUE to make @p obj widget's internal file
4713     * selector only display directories, @c EINA_FALSE to make files
4714     * to be displayed in it too
4715     *
4716     * This has the same effect as elm_fileselector_folder_only_set(),
4717     * but now applied to a file selector entry's internal file
4718     * selector.
4719     *
4720     * @see elm_fileselector_folder_only_get()
4721     */
4722    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4723
4724    /**
4725     * Get whether a given file selector entry widget's internal file
4726     * selector is displaying folders only or the directory contents,
4727     * as well.
4728     *
4729     * @param obj The file selector entry widget
4730     * @return @c EINA_TRUE if @p obj widget's internal file
4731     * selector is only displaying directories, @c EINA_FALSE if files
4732     * are being displayed in it too (and on errors)
4733     *
4734     * @see elm_fileselector_entry_folder_only_set() for more details
4735     */
4736    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4737
4738    /**
4739     * Enable/disable the file name entry box where the user can type
4740     * in a name for a file, in a given file selector entry widget's
4741     * internal file selector.
4742     *
4743     * @param obj The file selector entry widget
4744     * @param is_save @c EINA_TRUE to make @p obj widget's internal
4745     * file selector a "saving dialog", @c EINA_FALSE otherwise
4746     *
4747     * This has the same effect as elm_fileselector_is_save_set(),
4748     * but now applied to a file selector entry's internal file
4749     * selector.
4750     *
4751     * @see elm_fileselector_is_save_get()
4752     */
4753    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4754
4755    /**
4756     * Get whether the given file selector entry widget's internal
4757     * file selector is in "saving dialog" mode
4758     *
4759     * @param obj The file selector entry widget
4760     * @return @c EINA_TRUE, if @p obj widget's internal file selector
4761     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4762     * errors)
4763     *
4764     * @see elm_fileselector_entry_is_save_set() for more details
4765     */
4766    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4767
4768    /**
4769     * Set whether a given file selector entry widget's internal file
4770     * selector will raise an Elementary "inner window", instead of a
4771     * dedicated Elementary window. By default, it won't.
4772     *
4773     * @param obj The file selector entry widget
4774     * @param value @c EINA_TRUE to make it use an inner window, @c
4775     * EINA_TRUE to make it use a dedicated window
4776     *
4777     * @see elm_win_inwin_add() for more information on inner windows
4778     * @see elm_fileselector_entry_inwin_mode_get()
4779     */
4780    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4781
4782    /**
4783     * Get whether a given file selector entry widget's internal file
4784     * selector will raise an Elementary "inner window", instead of a
4785     * dedicated Elementary window.
4786     *
4787     * @param obj The file selector entry widget
4788     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4789     * if it will use a dedicated window
4790     *
4791     * @see elm_fileselector_entry_inwin_mode_set() for more details
4792     */
4793    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4794
4795    /**
4796     * Set the initial file system path for a given file selector entry
4797     * widget
4798     *
4799     * @param obj The file selector entry widget
4800     * @param path The path string
4801     *
4802     * It must be a <b>directory</b> path, which will have the contents
4803     * displayed initially in the file selector's view, when invoked
4804     * from @p obj. The default initial path is the @c "HOME"
4805     * environment variable's value.
4806     *
4807     * @see elm_fileselector_entry_path_get()
4808     */
4809    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4810
4811    /**
4812     * Get the parent directory's path to the latest file selection on
4813     * a given filer selector entry widget
4814     *
4815     * @param obj The file selector object
4816     * @return The (full) path of the directory of the last selection
4817     * on @p obj widget, a @b stringshared string
4818     *
4819     * @see elm_fileselector_entry_path_set()
4820     */
4821    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4822
4823    /**
4824     * @}
4825     */
4826
4827    /**
4828     * @defgroup Scroller Scroller
4829     *
4830     * A scroller holds a single object and "scrolls it around". This means that
4831     * it allows the user to use a scrollbar (or a finger) to drag the viewable
4832     * region around, allowing to move through a much larger object that is
4833     * contained in the scroller. The scroiller will always have a small minimum
4834     * size by default as it won't be limited by the contents of the scroller.
4835     *
4836     * Signals that you can add callbacks for are:
4837     * @li "edge,left" - the left edge of the content has been reached
4838     * @li "edge,right" - the right edge of the content has been reached
4839     * @li "edge,top" - the top edge of the content has been reached
4840     * @li "edge,bottom" - the bottom edge of the content has been reached
4841     * @li "scroll" - the content has been scrolled (moved)
4842     * @li "scroll,anim,start" - scrolling animation has started
4843     * @li "scroll,anim,stop" - scrolling animation has stopped
4844     * @li "scroll,drag,start" - dragging the contents around has started
4845     * @li "scroll,drag,stop" - dragging the contents around has stopped
4846     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
4847     * user intervetion.
4848     *
4849     * @note When Elemementary is in embedded mode the scrollbars will not be
4850     * dragable, they appear merely as indicators of how much has been scrolled.
4851     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
4852     * fingerscroll) won't work.
4853     *
4854     * In @ref tutorial_scroller you'll find an example of how to use most of
4855     * this API.
4856     * @{
4857     */
4858    /**
4859     * @brief Type that controls when scrollbars should appear.
4860     *
4861     * @see elm_scroller_policy_set()
4862     */
4863    typedef enum _Elm_Scroller_Policy
4864      {
4865         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
4866         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
4867         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
4868         ELM_SCROLLER_POLICY_LAST
4869      } Elm_Scroller_Policy;
4870    /**
4871     * @brief Add a new scroller to the parent
4872     *
4873     * @param parent The parent object
4874     * @return The new object or NULL if it cannot be created
4875     */
4876    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4877    /**
4878     * @brief Set the content of the scroller widget (the object to be scrolled around).
4879     *
4880     * @param obj The scroller object
4881     * @param content The new content object
4882     *
4883     * Once the content object is set, a previously set one will be deleted.
4884     * If you want to keep that old content object, use the
4885     * elm_scroller_content_unset() function.
4886     */
4887    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
4888    /**
4889     * @brief Get the content of the scroller widget
4890     *
4891     * @param obj The slider object
4892     * @return The content that is being used
4893     *
4894     * Return the content object which is set for this widget
4895     *
4896     * @see elm_scroller_content_set()
4897     */
4898    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4899    /**
4900     * @brief Unset the content of the scroller widget
4901     *
4902     * @param obj The slider object
4903     * @return The content that was being used
4904     *
4905     * Unparent and return the content object which was set for this widget
4906     *
4907     * @see elm_scroller_content_set()
4908     */
4909    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4910    /**
4911     * @brief Set custom theme elements for the scroller
4912     *
4913     * @param obj The scroller object
4914     * @param widget The widget name to use (default is "scroller")
4915     * @param base The base name to use (default is "base")
4916     */
4917    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
4918    /**
4919     * @brief Make the scroller minimum size limited to the minimum size of the content
4920     *
4921     * @param obj The scroller object
4922     * @param w Enable limiting minimum size horizontally
4923     * @param h Enable limiting minimum size vertically
4924     *
4925     * By default the scroller will be as small as its design allows,
4926     * irrespective of its content. This will make the scroller minimum size the
4927     * right size horizontally and/or vertically to perfectly fit its content in
4928     * that direction.
4929     */
4930    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
4931    /**
4932     * @brief Show a specific virtual region within the scroller content object
4933     *
4934     * @param obj The scroller object
4935     * @param x X coordinate of the region
4936     * @param y Y coordinate of the region
4937     * @param w Width of the region
4938     * @param h Height of the region
4939     *
4940     * This will ensure all (or part if it does not fit) of the designated
4941     * region in the virtual content object (0, 0 starting at the top-left of the
4942     * virtual content object) is shown within the scroller.
4943     */
4944    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);
4945    /**
4946     * @brief Set the scrollbar visibility policy
4947     *
4948     * @param obj The scroller object
4949     * @param policy_h Horizontal scrollbar policy
4950     * @param policy_v Vertical scrollbar policy
4951     *
4952     * This sets the scrollbar visibility policy for the given scroller.
4953     * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
4954     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
4955     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
4956     * respectively for the horizontal and vertical scrollbars.
4957     */
4958    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4959    /**
4960     * @brief Gets scrollbar visibility policy
4961     *
4962     * @param obj The scroller object
4963     * @param policy_h Horizontal scrollbar policy
4964     * @param policy_v Vertical scrollbar policy
4965     *
4966     * @see elm_scroller_policy_set()
4967     */
4968    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
4969    /**
4970     * @brief Get the currently visible content region
4971     *
4972     * @param obj The scroller object
4973     * @param x X coordinate of the region
4974     * @param y Y coordinate of the region
4975     * @param w Width of the region
4976     * @param h Height of the region
4977     *
4978     * This gets the current region in the content object that is visible through
4979     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
4980     * w, @p h values pointed to.
4981     *
4982     * @note All coordinates are relative to the content.
4983     *
4984     * @see elm_scroller_region_show()
4985     */
4986    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);
4987    /**
4988     * @brief Get the size of the content object
4989     *
4990     * @param obj The scroller object
4991     * @param w Width return
4992     * @param h Height return
4993     *
4994     * This gets the size of the content object of the scroller.
4995     */
4996    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
4997    /**
4998     * @brief Set bouncing behavior
4999     *
5000     * @param obj The scroller object
5001     * @param h_bounce Will the scroller bounce horizontally or not
5002     * @param v_bounce Will the scroller bounce vertically or not
5003     *
5004     * When scrolling, the scroller may "bounce" when reaching an edge of the
5005     * content object. This is a visual way to indicate the end has been reached.
5006     * This is enabled by default for both axis. This will set if it is enabled
5007     * for that axis with the boolean parameters for each axis.
5008     */
5009    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5010    /**
5011     * @brief Get the bounce mode
5012     *
5013     * @param obj The Scroller object
5014     * @param h_bounce Allow bounce horizontally
5015     * @param v_bounce Allow bounce vertically
5016     *
5017     * @see elm_scroller_bounce_set()
5018     */
5019    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5020    /**
5021     * @brief Set scroll page size relative to viewport size.
5022     *
5023     * @param obj The scroller object
5024     * @param h_pagerel The horizontal page relative size
5025     * @param v_pagerel The vertical page relative size
5026     *
5027     * The scroller is capable of limiting scrolling by the user to "pages". That
5028     * is to jump by and only show a "whole page" at a time as if the continuous
5029     * area of the scroller content is split into page sized pieces. This sets
5030     * the size of a page relative to the viewport of the scroller. 1.0 is "1
5031     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5032     * axis. This is mutually exclusive with page size
5033     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
5034     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5035     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5036     * the other axis.
5037     */
5038    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5039    /**
5040     * @brief Set scroll page size.
5041     *
5042     * @param obj The scroller object
5043     * @param h_pagesize The horizontal page size
5044     * @param v_pagesize The vertical page size
5045     *
5046     * This sets the page size to an absolute fixed value, with 0 turning it off
5047     * for that axis.
5048     *
5049     * @see elm_scroller_page_relative_set()
5050     */
5051    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5052    /**
5053     * @brief Show a specific virtual region within the scroller content object.
5054     *
5055     * @param obj The scroller object
5056     * @param x X coordinate of the region
5057     * @param y Y coordinate of the region
5058     * @param w Width of the region
5059     * @param h Height of the region
5060     *
5061     * This will ensure all (or part if it does not fit) of the designated
5062     * region in the virtual content object (0, 0 starting at the top-left of the
5063     * virtual content object) is shown within the scroller. Unlike
5064     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5065     * to this location (if configuration in general calls for transitions). It
5066     * may not jump immediately to the new location and make take a while and
5067     * show other content along the way.
5068     *
5069     * @see elm_scroller_region_show()
5070     */
5071    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);
5072    /**
5073     * @brief Set event propagation on a scroller
5074     *
5075     * @param obj The scroller object
5076     * @param propagation If propagation is enabled or not
5077     *
5078     * This enables or disabled event propagation from the scroller content to
5079     * the scroller and its parent. By default event propagation is disabled.
5080     */
5081    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5082    /**
5083     * @brief Get event propagation for a scroller
5084     *
5085     * @param obj The scroller object
5086     * @return The propagation state
5087     *
5088     * This gets the event propagation for a scroller.
5089     *
5090     * @see elm_scroller_propagate_events_set()
5091     */
5092    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
5093    /**
5094     * @}
5095     */
5096
5097    /**
5098     * @defgroup Label Label
5099     *
5100     * @image html img/widget/label/preview-00.png
5101     * @image latex img/widget/label/preview-00.eps
5102     *
5103     * @brief Widget to display text, with simple html-like markup.
5104     *
5105     * The Label widget @b doesn't allow text to overflow its boundaries, if the
5106     * text doesn't fit the geometry of the label it will be ellipsized or be
5107     * cut. Elementary provides several themes for this widget:
5108     * @li default - No animation
5109     * @li marker - Centers the text in the label and make it bold by default
5110     * @li slide_long - The entire text appears from the right of the screen and
5111     * slides until it disappears in the left of the screen(reappering on the
5112     * right again).
5113     * @li slide_short - The text appears in the left of the label and slides to
5114     * the right to show the overflow. When all of the text has been shown the
5115     * position is reset.
5116     * @li slide_bounce - The text appears in the left of the label and slides to
5117     * the right to show the overflow. When all of the text has been shown the
5118     * animation reverses, moving the text to the left.
5119     *
5120     * Custom themes can of course invent new markup tags and style them any way
5121     * they like.
5122     *
5123     * See @ref tutorial_label for a demonstration of how to use a label widget.
5124     * @{
5125     */
5126    /**
5127     * @brief Add a new label to the parent
5128     *
5129     * @param parent The parent object
5130     * @return The new object or NULL if it cannot be created
5131     */
5132    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5133    /**
5134     * @brief Set the label on the label object
5135     *
5136     * @param obj The label object
5137     * @param label The label will be used on the label object
5138     * @deprecated See elm_object_text_set()
5139     */
5140    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 */
5141    /**
5142     * @brief Get the label used on the label object
5143     *
5144     * @param obj The label object
5145     * @return The string inside the label
5146     * @deprecated See elm_object_text_get()
5147     */
5148    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5149    /**
5150     * @brief Set the wrapping behavior of the label
5151     *
5152     * @param obj The label object
5153     * @param wrap To wrap text or not
5154     *
5155     * By default no wrapping is done. Possible values for @p wrap are:
5156     * @li ELM_WRAP_NONE - No wrapping
5157     * @li ELM_WRAP_CHAR - wrap between characters
5158     * @li ELM_WRAP_WORD - wrap between words
5159     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5160     */
5161    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5162    /**
5163     * @brief Get the wrapping behavior of the label
5164     *
5165     * @param obj The label object
5166     * @return Wrap type
5167     *
5168     * @see elm_label_line_wrap_set()
5169     */
5170    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5171    /**
5172     * @brief Set wrap width of the label
5173     *
5174     * @param obj The label object
5175     * @param w The wrap width in pixels at a minimum where words need to wrap
5176     *
5177     * This function sets the maximum width size hint of the label.
5178     *
5179     * @warning This is only relevant if the label is inside a container.
5180     */
5181    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5182    /**
5183     * @brief Get wrap width of the label
5184     *
5185     * @param obj The label object
5186     * @return The wrap width in pixels at a minimum where words need to wrap
5187     *
5188     * @see elm_label_wrap_width_set()
5189     */
5190    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5191    /**
5192     * @brief Set wrap height of the label
5193     *
5194     * @param obj The label object
5195     * @param h The wrap height in pixels at a minimum where words need to wrap
5196     *
5197     * This function sets the maximum height size hint of the label.
5198     *
5199     * @warning This is only relevant if the label is inside a container.
5200     */
5201    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5202    /**
5203     * @brief get wrap width of the label
5204     *
5205     * @param obj The label object
5206     * @return The wrap height in pixels at a minimum where words need to wrap
5207     */
5208    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5209    /**
5210     * @brief Set the font size on the label object.
5211     *
5212     * @param obj The label object
5213     * @param size font size
5214     *
5215     * @warning NEVER use this. It is for hyper-special cases only. use styles
5216     * instead. e.g. "big", "medium", "small" - or better name them by use:
5217     * "title", "footnote", "quote" etc.
5218     */
5219    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5220    /**
5221     * @brief Set the text color on the label object
5222     *
5223     * @param obj The label object
5224     * @param r Red property background color of The label object
5225     * @param g Green property background color of The label object
5226     * @param b Blue property background color of The label object
5227     * @param a Alpha property background color of The label object
5228     *
5229     * @warning NEVER use this. It is for hyper-special cases only. use styles
5230     * instead. e.g. "big", "medium", "small" - or better name them by use:
5231     * "title", "footnote", "quote" etc.
5232     */
5233    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);
5234    /**
5235     * @brief Set the text align on the label object
5236     *
5237     * @param obj The label object
5238     * @param align align mode ("left", "center", "right")
5239     *
5240     * @warning NEVER use this. It is for hyper-special cases only. use styles
5241     * instead. e.g. "big", "medium", "small" - or better name them by use:
5242     * "title", "footnote", "quote" etc.
5243     */
5244    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5245    /**
5246     * @brief Set background color of the label
5247     *
5248     * @param obj The label object
5249     * @param r Red property background color of The label object
5250     * @param g Green property background color of The label object
5251     * @param b Blue property background color of The label object
5252     * @param a Alpha property background alpha of The label object
5253     *
5254     * @warning NEVER use this. It is for hyper-special cases only. use styles
5255     * instead. e.g. "big", "medium", "small" - or better name them by use:
5256     * "title", "footnote", "quote" etc.
5257     */
5258    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);
5259    /**
5260     * @brief Set the ellipsis behavior of the label
5261     *
5262     * @param obj The label object
5263     * @param ellipsis To ellipsis text or not
5264     *
5265     * If set to true and the text doesn't fit in the label an ellipsis("...")
5266     * will be shown at the end of the widget.
5267     *
5268     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5269     * choosen wrap method was ELM_WRAP_WORD.
5270     */
5271    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5272    /**
5273     * @brief Set the text slide of the label
5274     *
5275     * @param obj The label object
5276     * @param slide To start slide or stop
5277     *
5278     * If set to true the text of the label will slide throught the length of
5279     * label.
5280     *
5281     * @warning This only work with the themes "slide_short", "slide_long" and
5282     * "slide_bounce".
5283     */
5284    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5285    /**
5286     * @brief Get the text slide mode of the label
5287     *
5288     * @param obj The label object
5289     * @return slide slide mode value
5290     *
5291     * @see elm_label_slide_set()
5292     */
5293    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5294    /**
5295     * @brief Set the slide duration(speed) of the label
5296     *
5297     * @param obj The label object
5298     * @return The duration in seconds in moving text from slide begin position
5299     * to slide end position
5300     */
5301    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5302    /**
5303     * @brief Get the slide duration(speed) of the label
5304     *
5305     * @param obj The label object
5306     * @return The duration time in moving text from slide begin position to slide end position
5307     *
5308     * @see elm_label_slide_duration_set()
5309     */
5310    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5311    /**
5312     * @}
5313     */
5314
5315    /**
5316     * @defgroup Toggle Toggle
5317     *
5318     * @image html img/widget/toggle/preview-00.png
5319     * @image latex img/widget/toggle/preview-00.eps
5320     *
5321     * @brief A toggle is a slider which can be used to toggle between
5322     * two values.  It has two states: on and off.
5323     *
5324     * Signals that you can add callbacks for are:
5325     * @li "changed" - Whenever the toggle value has been changed.  Is not called
5326     *                 until the toggle is released by the cursor (assuming it
5327     *                 has been triggered by the cursor in the first place).
5328     *
5329     * @ref tutorial_toggle show how to use a toggle.
5330     * @{
5331     */
5332    /**
5333     * @brief Add a toggle to @p parent.
5334     *
5335     * @param parent The parent object
5336     *
5337     * @return The toggle object
5338     */
5339    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5340    /**
5341     * @brief Sets the label to be displayed with the toggle.
5342     *
5343     * @param obj The toggle object
5344     * @param label The label to be displayed
5345     *
5346     * @deprecated use elm_object_text_set() instead.
5347     */
5348    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5349    /**
5350     * @brief Gets the label of the toggle
5351     *
5352     * @param obj  toggle object
5353     * @return The label of the toggle
5354     *
5355     * @deprecated use elm_object_text_get() instead.
5356     */
5357    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5358    /**
5359     * @brief Set the icon used for the toggle
5360     *
5361     * @param obj The toggle object
5362     * @param icon The icon object for the button
5363     *
5364     * Once the icon object is set, a previously set one will be deleted
5365     * If you want to keep that old content object, use the
5366     * elm_toggle_icon_unset() function.
5367     */
5368    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5369    /**
5370     * @brief Get the icon used for the toggle
5371     *
5372     * @param obj The toggle object
5373     * @return The icon object that is being used
5374     *
5375     * Return the icon object which is set for this widget.
5376     *
5377     * @see elm_toggle_icon_set()
5378     */
5379    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5380    /**
5381     * @brief Unset the icon used for the toggle
5382     *
5383     * @param obj The toggle object
5384     * @return The icon object that was being used
5385     *
5386     * Unparent and return the icon object which was set for this widget.
5387     *
5388     * @see elm_toggle_icon_set()
5389     */
5390    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5391    /**
5392     * @brief Sets the labels to be associated with the on and off states of the toggle.
5393     *
5394     * @param obj The toggle object
5395     * @param onlabel The label displayed when the toggle is in the "on" state
5396     * @param offlabel The label displayed when the toggle is in the "off" state
5397     */
5398    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5399    /**
5400     * @brief Gets the labels associated with the on and off states of the toggle.
5401     *
5402     * @param obj The toggle object
5403     * @param onlabel A char** to place the onlabel of @p obj into
5404     * @param offlabel A char** to place the offlabel of @p obj into
5405     */
5406    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5407    /**
5408     * @brief Sets the state of the toggle to @p state.
5409     *
5410     * @param obj The toggle object
5411     * @param state The state of @p obj
5412     */
5413    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5414    /**
5415     * @brief Gets the state of the toggle to @p state.
5416     *
5417     * @param obj The toggle object
5418     * @return The state of @p obj
5419     */
5420    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5421    /**
5422     * @brief Sets the state pointer of the toggle to @p statep.
5423     *
5424     * @param obj The toggle object
5425     * @param statep The state pointer of @p obj
5426     */
5427    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5428    /**
5429     * @}
5430     */
5431
5432    /**
5433     * @defgroup Frame Frame
5434     *
5435     * @image html img/widget/frame/preview-00.png
5436     * @image latex img/widget/frame/preview-00.eps
5437     *
5438     * @brief Frame is a widget that holds some content and has a title.
5439     *
5440     * The default look is a frame with a title, but Frame supports multple
5441     * styles:
5442     * @li default
5443     * @li pad_small
5444     * @li pad_medium
5445     * @li pad_large
5446     * @li pad_huge
5447     * @li outdent_top
5448     * @li outdent_bottom
5449     *
5450     * Of all this styles only default shows the title. Frame emits no signals.
5451     *
5452     * For a detailed example see the @ref tutorial_frame.
5453     *
5454     * @{
5455     */
5456    /**
5457     * @brief Add a new frame to the parent
5458     *
5459     * @param parent The parent object
5460     * @return The new object or NULL if it cannot be created
5461     */
5462    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5463    /**
5464     * @brief Set the frame label
5465     *
5466     * @param obj The frame object
5467     * @param label The label of this frame object
5468     *
5469     * @deprecated use elm_object_text_set() instead.
5470     */
5471    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5472    /**
5473     * @brief Get the frame label
5474     *
5475     * @param obj The frame object
5476     *
5477     * @return The label of this frame objet or NULL if unable to get frame
5478     *
5479     * @deprecated use elm_object_text_get() instead.
5480     */
5481    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5482    /**
5483     * @brief Set the content of the frame widget
5484     *
5485     * Once the content object is set, a previously set one will be deleted.
5486     * If you want to keep that old content object, use the
5487     * elm_frame_content_unset() function.
5488     *
5489     * @param obj The frame object
5490     * @param content The content will be filled in this frame object
5491     */
5492    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5493    /**
5494     * @brief Get the content of the frame widget
5495     *
5496     * Return the content object which is set for this widget
5497     *
5498     * @param obj The frame object
5499     * @return The content that is being used
5500     */
5501    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5502    /**
5503     * @brief Unset the content of the frame widget
5504     *
5505     * Unparent and return the content object which was set for this widget
5506     *
5507     * @param obj The frame object
5508     * @return The content that was being used
5509     */
5510    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5511    /**
5512     * @}
5513     */
5514
5515    /**
5516     * @defgroup Table Table
5517     *
5518     * A container widget to arrange other widgets in a table where items can
5519     * also span multiple columns or rows - even overlap (and then be raised or
5520     * lowered accordingly to adjust stacking if they do overlap).
5521     *
5522     * The followin are examples of how to use a table:
5523     * @li @ref tutorial_table_01
5524     * @li @ref tutorial_table_02
5525     *
5526     * @{
5527     */
5528    /**
5529     * @brief Add a new table to the parent
5530     *
5531     * @param parent The parent object
5532     * @return The new object or NULL if it cannot be created
5533     */
5534    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5535    /**
5536     * @brief Set the homogeneous layout in the table
5537     *
5538     * @param obj The layout object
5539     * @param homogeneous A boolean to set if the layout is homogeneous in the
5540     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
5541     */
5542    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5543    /**
5544     * @brief Get the current table homogeneous mode.
5545     *
5546     * @param obj The table object
5547     * @return A boolean to indicating if the layout is homogeneous in the table
5548     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
5549     */
5550    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5551    /**
5552     * @warning <b>Use elm_table_homogeneous_set() instead</b>
5553     */
5554    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5555    /**
5556     * @warning <b>Use elm_table_homogeneous_get() instead</b>
5557     */
5558    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5559    /**
5560     * @brief Set padding between cells.
5561     *
5562     * @param obj The layout object.
5563     * @param horizontal set the horizontal padding.
5564     * @param vertical set the vertical padding.
5565     *
5566     * Default value is 0.
5567     */
5568    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5569    /**
5570     * @brief Get padding between cells.
5571     *
5572     * @param obj The layout object.
5573     * @param horizontal set the horizontal padding.
5574     * @param vertical set the vertical padding.
5575     */
5576    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5577    /**
5578     * @brief Add a subobject on the table with the coordinates passed
5579     *
5580     * @param obj The table object
5581     * @param subobj The subobject to be added to the table
5582     * @param x Row number
5583     * @param y Column number
5584     * @param w rowspan
5585     * @param h colspan
5586     *
5587     * @note All positioning inside the table is relative to rows and columns, so
5588     * a value of 0 for x and y, means the top left cell of the table, and a
5589     * value of 1 for w and h means @p subobj only takes that 1 cell.
5590     */
5591    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5592    /**
5593     * @brief Remove child from table.
5594     *
5595     * @param obj The table object
5596     * @param subobj The subobject
5597     */
5598    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5599    /**
5600     * @brief Faster way to remove all child objects from a table object.
5601     *
5602     * @param obj The table object
5603     * @param clear If true, will delete children, else just remove from table.
5604     */
5605    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5606    /**
5607     * @brief Set the packing location of an existing child of the table
5608     *
5609     * @param subobj The subobject to be modified in the table
5610     * @param x Row number
5611     * @param y Column number
5612     * @param w rowspan
5613     * @param h colspan
5614     *
5615     * Modifies the position of an object already in the table.
5616     *
5617     * @note All positioning inside the table is relative to rows and columns, so
5618     * a value of 0 for x and y, means the top left cell of the table, and a
5619     * value of 1 for w and h means @p subobj only takes that 1 cell.
5620     */
5621    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5622    /**
5623     * @brief Get the packing location of an existing child of the table
5624     *
5625     * @param subobj The subobject to be modified in the table
5626     * @param x Row number
5627     * @param y Column number
5628     * @param w rowspan
5629     * @param h colspan
5630     *
5631     * @see elm_table_pack_set()
5632     */
5633    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5634    /**
5635     * @}
5636     */
5637
5638    /**
5639     * @defgroup Gengrid Gengrid (Generic grid)
5640     *
5641     * This widget aims to position objects in a grid layout while
5642     * actually creating and rendering only the visible ones, using the
5643     * same idea as the @ref Genlist "genlist": the user defines a @b
5644     * class for each item, specifying functions that will be called at
5645     * object creation, deletion, etc. When those items are selected by
5646     * the user, a callback function is issued. Users may interact with
5647     * a gengrid via the mouse (by clicking on items to select them and
5648     * clicking on the grid's viewport and swiping to pan the whole
5649     * view) or via the keyboard, navigating through item with the
5650     * arrow keys.
5651     *
5652     * @section Gengrid_Layouts Gengrid layouts
5653     *
5654     * Gengrids may layout its items in one of two possible layouts:
5655     * - horizontal or
5656     * - vertical.
5657     *
5658     * When in "horizontal mode", items will be placed in @b columns,
5659     * from top to bottom and, when the space for a column is filled,
5660     * another one is started on the right, thus expanding the grid
5661     * horizontally, making for horizontal scrolling. When in "vertical
5662     * mode" , though, items will be placed in @b rows, from left to
5663     * right and, when the space for a row is filled, another one is
5664     * started below, thus expanding the grid vertically (and making
5665     * for vertical scrolling).
5666     *
5667     * @section Gengrid_Items Gengrid items
5668     *
5669     * An item in a gengrid can have 0 or more text labels (they can be
5670     * regular text or textblock Evas objects - that's up to the style
5671     * to determine), 0 or more icons (which are simply objects
5672     * swallowed into the gengrid item's theming Edje object) and 0 or
5673     * more <b>boolean states</b>, which have the behavior left to the
5674     * user to define. The Edje part names for each of these properties
5675     * will be looked up, in the theme file for the gengrid, under the
5676     * Edje (string) data items named @c "labels", @c "icons" and @c
5677     * "states", respectively. For each of those properties, if more
5678     * than one part is provided, they must have names listed separated
5679     * by spaces in the data fields. For the default gengrid item
5680     * theme, we have @b one label part (@c "elm.text"), @b two icon
5681     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5682     * no state parts.
5683     *
5684     * A gengrid item may be at one of several styles. Elementary
5685     * provides one by default - "default", but this can be extended by
5686     * system or application custom themes/overlays/extensions (see
5687     * @ref Theme "themes" for more details).
5688     *
5689     * @section Gengrid_Item_Class Gengrid item classes
5690     *
5691     * In order to have the ability to add and delete items on the fly,
5692     * gengrid implements a class (callback) system where the
5693     * application provides a structure with information about that
5694     * type of item (gengrid may contain multiple different items with
5695     * different classes, states and styles). Gengrid will call the
5696     * functions in this struct (methods) when an item is "realized"
5697     * (i.e., created dynamically, while the user is scrolling the
5698     * grid). All objects will simply be deleted when no longer needed
5699     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5700     * contains the following members:
5701     * - @c item_style - This is a constant string and simply defines
5702     * the name of the item style. It @b must be specified and the
5703     * default should be @c "default".
5704     * - @c func.label_get - This function is called when an item
5705     * object is actually created. The @c data parameter will point to
5706     * the same data passed to elm_gengrid_item_append() and related
5707     * item creation functions. The @c obj parameter is the gengrid
5708     * object itself, while the @c part one is the name string of one
5709     * of the existing text parts in the Edje group implementing the
5710     * item's theme. This function @b must return a strdup'()ed string,
5711     * as the caller will free() it when done. See
5712     * #GridItemLabelGetFunc.
5713     * - @c func.icon_get - This function is called when an item object
5714     * is actually created. The @c data parameter will point to the
5715     * same data passed to elm_gengrid_item_append() and related item
5716     * creation functions. The @c obj parameter is the gengrid object
5717     * itself, while the @c part one is the name string of one of the
5718     * existing (icon) swallow parts in the Edje group implementing the
5719     * item's theme. It must return @c NULL, when no icon is desired,
5720     * or a valid object handle, otherwise. The object will be deleted
5721     * by the gengrid on its deletion or when the item is "unrealized".
5722     * See #GridItemIconGetFunc.
5723     * - @c func.state_get - This function is called when an item
5724     * object is actually created. The @c data parameter will point to
5725     * the same data passed to elm_gengrid_item_append() and related
5726     * item creation functions. The @c obj parameter is the gengrid
5727     * object itself, while the @c part one is the name string of one
5728     * of the state parts in the Edje group implementing the item's
5729     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5730     * true/on. Gengrids will emit a signal to its theming Edje object
5731     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5732     * "source" arguments, respectively, when the state is true (the
5733     * default is false), where @c XXX is the name of the (state) part.
5734     * See #GridItemStateGetFunc.
5735     * - @c func.del - This is called when elm_gengrid_item_del() is
5736     * called on an item or elm_gengrid_clear() is called on the
5737     * gengrid. This is intended for use when gengrid items are
5738     * deleted, so any data attached to the item (e.g. its data
5739     * parameter on creation) can be deleted. See #GridItemDelFunc.
5740     *
5741     * @section Gengrid_Usage_Hints Usage hints
5742     *
5743     * If the user wants to have multiple items selected at the same
5744     * time, elm_gengrid_multi_select_set() will permit it. If the
5745     * gengrid is single-selection only (the default), then
5746     * elm_gengrid_select_item_get() will return the selected item or
5747     * @c NULL, if none is selected. If the gengrid is under
5748     * multi-selection, then elm_gengrid_selected_items_get() will
5749     * return a list (that is only valid as long as no items are
5750     * modified (added, deleted, selected or unselected) of child items
5751     * on a gengrid.
5752     *
5753     * If an item changes (internal (boolean) state, label or icon
5754     * changes), then use elm_gengrid_item_update() to have gengrid
5755     * update the item with the new state. A gengrid will re-"realize"
5756     * the item, thus calling the functions in the
5757     * #Elm_Gengrid_Item_Class set for that item.
5758     *
5759     * To programmatically (un)select an item, use
5760     * elm_gengrid_item_selected_set(). To get its selected state use
5761     * elm_gengrid_item_selected_get(). To make an item disabled
5762     * (unable to be selected and appear differently) use
5763     * elm_gengrid_item_disabled_set() to set this and
5764     * elm_gengrid_item_disabled_get() to get the disabled state.
5765     *
5766     * Grid cells will only have their selection smart callbacks called
5767     * when firstly getting selected. Any further clicks will do
5768     * nothing, unless you enable the "always select mode", with
5769     * elm_gengrid_always_select_mode_set(), thus making every click to
5770     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5771     * turn off the ability to select items entirely in the widget and
5772     * they will neither appear selected nor call the selection smart
5773     * callbacks.
5774     *
5775     * Remember that you can create new styles and add your own theme
5776     * augmentation per application with elm_theme_extension_add(). If
5777     * you absolutely must have a specific style that overrides any
5778     * theme the user or system sets up you can use
5779     * elm_theme_overlay_add() to add such a file.
5780     *
5781     * @section Gengrid_Smart_Events Gengrid smart events
5782     *
5783     * Smart events that you can add callbacks for are:
5784     * - @c "activated" - The user has double-clicked or pressed
5785     *   (enter|return|spacebar) on an item. The @c event_info parameter
5786     *   is the gengrid item that was activated.
5787     * - @c "clicked,double" - The user has double-clicked an item.
5788     *   The @c event_info parameter is the gengrid item that was double-clicked.
5789     * - @c "selected" - The user has made an item selected. The
5790     *   @c event_info parameter is the gengrid item that was selected.
5791     * - @c "unselected" - The user has made an item unselected. The
5792     *   @c event_info parameter is the gengrid item that was unselected.
5793     * - @c "realized" - This is called when the item in the gengrid
5794     *   has its implementing Evas object instantiated, de facto. @c
5795     *   event_info is the gengrid item that was created. The object
5796     *   may be deleted at any time, so it is highly advised to the
5797     *   caller @b not to use the object pointer returned from
5798     *   elm_gengrid_item_object_get(), because it may point to freed
5799     *   objects.
5800     * - @c "unrealized" - This is called when the implementing Evas
5801     *   object for this item is deleted. @c event_info is the gengrid
5802     *   item that was deleted.
5803     * - @c "changed" - Called when an item is added, removed, resized
5804     *   or moved and when the gengrid is resized or gets "horizontal"
5805     *   property changes.
5806     * - @c "drag,start,up" - Called when the item in the gengrid has
5807     *   been dragged (not scrolled) up.
5808     * - @c "drag,start,down" - Called when the item in the gengrid has
5809     *   been dragged (not scrolled) down.
5810     * - @c "drag,start,left" - Called when the item in the gengrid has
5811     *   been dragged (not scrolled) left.
5812     * - @c "drag,start,right" - Called when the item in the gengrid has
5813     *   been dragged (not scrolled) right.
5814     * - @c "drag,stop" - Called when the item in the gengrid has
5815     *   stopped being dragged.
5816     * - @c "drag" - Called when the item in the gengrid is being
5817     *   dragged.
5818     * - @c "scroll" - called when the content has been scrolled
5819     *   (moved).
5820     * - @c "scroll,drag,start" - called when dragging the content has
5821     *   started.
5822     * - @c "scroll,drag,stop" - called when dragging the content has
5823     *   stopped.
5824     *
5825     * List of gendrid examples:
5826     * @li @ref gengrid_example
5827     */
5828
5829    /**
5830     * @addtogroup Gengrid
5831     * @{
5832     */
5833
5834    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5835    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5836    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5837    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5838    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5839    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5840    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5841
5842    /**
5843     * @struct _Elm_Gengrid_Item_Class
5844     *
5845     * Gengrid item class definition. See @ref Gengrid_Item_Class for
5846     * field details.
5847     */
5848    struct _Elm_Gengrid_Item_Class
5849      {
5850         const char             *item_style;
5851         struct _Elm_Gengrid_Item_Class_Func
5852           {
5853              GridItemLabelGetFunc  label_get;
5854              GridItemIconGetFunc   icon_get;
5855              GridItemStateGetFunc  state_get;
5856              GridItemDelFunc       del;
5857           } func;
5858      }; /**< #Elm_Gengrid_Item_Class member definitions */
5859
5860    /**
5861     * Add a new gengrid widget to the given parent Elementary
5862     * (container) object
5863     *
5864     * @param parent The parent object
5865     * @return a new gengrid widget handle or @c NULL, on errors
5866     *
5867     * This function inserts a new gengrid widget on the canvas.
5868     *
5869     * @see elm_gengrid_item_size_set()
5870     * @see elm_gengrid_horizontal_set()
5871     * @see elm_gengrid_item_append()
5872     * @see elm_gengrid_item_del()
5873     * @see elm_gengrid_clear()
5874     *
5875     * @ingroup Gengrid
5876     */
5877    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5878
5879    /**
5880     * Set the size for the items of a given gengrid widget
5881     *
5882     * @param obj The gengrid object.
5883     * @param w The items' width.
5884     * @param h The items' height;
5885     *
5886     * A gengrid, after creation, has still no information on the size
5887     * to give to each of its cells. So, you most probably will end up
5888     * with squares one @ref Fingers "finger" wide, the default
5889     * size. Use this function to force a custom size for you items,
5890     * making them as big as you wish.
5891     *
5892     * @see elm_gengrid_item_size_get()
5893     *
5894     * @ingroup Gengrid
5895     */
5896    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5897
5898    /**
5899     * Get the size set for the items of a given gengrid widget
5900     *
5901     * @param obj The gengrid object.
5902     * @param w Pointer to a variable where to store the items' width.
5903     * @param h Pointer to a variable where to store the items' height.
5904     *
5905     * @note Use @c NULL pointers on the size values you're not
5906     * interested in: they'll be ignored by the function.
5907     *
5908     * @see elm_gengrid_item_size_get() for more details
5909     *
5910     * @ingroup Gengrid
5911     */
5912    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5913
5914    /**
5915     * Set the items grid's alignment within a given gengrid widget
5916     *
5917     * @param obj The gengrid object.
5918     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
5919     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
5920     *
5921     * This sets the alignment of the whole grid of items of a gengrid
5922     * within its given viewport. By default, those values are both
5923     * 0.5, meaning that the gengrid will have its items grid placed
5924     * exactly in the middle of its viewport.
5925     *
5926     * @note If given alignment values are out of the cited ranges,
5927     * they'll be changed to the nearest boundary values on the valid
5928     * ranges.
5929     *
5930     * @see elm_gengrid_align_get()
5931     *
5932     * @ingroup Gengrid
5933     */
5934    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5935
5936    /**
5937     * Get the items grid's alignment values within a given gengrid
5938     * widget
5939     *
5940     * @param obj The gengrid object.
5941     * @param align_x Pointer to a variable where to store the
5942     * horizontal alignment.
5943     * @param align_y Pointer to a variable where to store the vertical
5944     * alignment.
5945     *
5946     * @note Use @c NULL pointers on the alignment values you're not
5947     * interested in: they'll be ignored by the function.
5948     *
5949     * @see elm_gengrid_align_set() for more details
5950     *
5951     * @ingroup Gengrid
5952     */
5953    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5954
5955    /**
5956     * Set whether a given gengrid widget is or not able have items
5957     * @b reordered
5958     *
5959     * @param obj The gengrid object
5960     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
5961     * @c EINA_FALSE to turn it off
5962     *
5963     * If a gengrid is set to allow reordering, a click held for more
5964     * than 0.5 over a given item will highlight it specially,
5965     * signalling the gengrid has entered the reordering state. From
5966     * that time on, the user will be able to, while still holding the
5967     * mouse button down, move the item freely in the gengrid's
5968     * viewport, replacing to said item to the locations it goes to.
5969     * The replacements will be animated and, whenever the user
5970     * releases the mouse button, the item being replaced gets a new
5971     * definitive place in the grid.
5972     *
5973     * @see elm_gengrid_reorder_mode_get()
5974     *
5975     * @ingroup Gengrid
5976     */
5977    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5978
5979    /**
5980     * Get whether a given gengrid widget is or not able have items
5981     * @b reordered
5982     *
5983     * @param obj The gengrid object
5984     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
5985     * off
5986     *
5987     * @see elm_gengrid_reorder_mode_set() for more details
5988     *
5989     * @ingroup Gengrid
5990     */
5991    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5992
5993    /**
5994     * Append a new item in a given gengrid widget.
5995     *
5996     * @param obj The gengrid object.
5997     * @param gic The item class for the item.
5998     * @param data The item data.
5999     * @param func Convenience function called when the item is
6000     * selected.
6001     * @param func_data Data to be passed to @p func.
6002     * @return A handle to the item added or @c NULL, on errors.
6003     *
6004     * This adds an item to the beginning of the gengrid.
6005     *
6006     * @see elm_gengrid_item_prepend()
6007     * @see elm_gengrid_item_insert_before()
6008     * @see elm_gengrid_item_insert_after()
6009     * @see elm_gengrid_item_del()
6010     *
6011     * @ingroup Gengrid
6012     */
6013    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);
6014
6015    /**
6016     * Prepend a new item in a given gengrid widget.
6017     *
6018     * @param obj The gengrid object.
6019     * @param gic The item class for the item.
6020     * @param data The item data.
6021     * @param func Convenience function called when the item is
6022     * selected.
6023     * @param func_data Data to be passed to @p func.
6024     * @return A handle to the item added or @c NULL, on errors.
6025     *
6026     * This adds an item to the end of the gengrid.
6027     *
6028     * @see elm_gengrid_item_append()
6029     * @see elm_gengrid_item_insert_before()
6030     * @see elm_gengrid_item_insert_after()
6031     * @see elm_gengrid_item_del()
6032     *
6033     * @ingroup Gengrid
6034     */
6035    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);
6036
6037    /**
6038     * Insert an item before another in a gengrid widget
6039     *
6040     * @param obj The gengrid object.
6041     * @param gic The item class for the item.
6042     * @param data The item data.
6043     * @param relative The item to place this new one before.
6044     * @param func Convenience function called when the item is
6045     * selected.
6046     * @param func_data Data to be passed to @p func.
6047     * @return A handle to the item added or @c NULL, on errors.
6048     *
6049     * This inserts an item before another in the gengrid.
6050     *
6051     * @see elm_gengrid_item_append()
6052     * @see elm_gengrid_item_prepend()
6053     * @see elm_gengrid_item_insert_after()
6054     * @see elm_gengrid_item_del()
6055     *
6056     * @ingroup Gengrid
6057     */
6058    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);
6059
6060    /**
6061     * Insert an item after another in a gengrid widget
6062     *
6063     * @param obj The gengrid object.
6064     * @param gic The item class for the item.
6065     * @param data The item data.
6066     * @param relative The item to place this new one after.
6067     * @param func Convenience function called when the item is
6068     * selected.
6069     * @param func_data Data to be passed to @p func.
6070     * @return A handle to the item added or @c NULL, on errors.
6071     *
6072     * This inserts an item after another in the gengrid.
6073     *
6074     * @see elm_gengrid_item_append()
6075     * @see elm_gengrid_item_prepend()
6076     * @see elm_gengrid_item_insert_after()
6077     * @see elm_gengrid_item_del()
6078     *
6079     * @ingroup Gengrid
6080     */
6081    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);
6082
6083    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);
6084
6085    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);
6086
6087    /**
6088     * Set whether items on a given gengrid widget are to get their
6089     * selection callbacks issued for @b every subsequent selection
6090     * click on them or just for the first click.
6091     *
6092     * @param obj The gengrid object
6093     * @param always_select @c EINA_TRUE to make items "always
6094     * selected", @c EINA_FALSE, otherwise
6095     *
6096     * By default, grid items will only call their selection callback
6097     * function when firstly getting selected, any subsequent further
6098     * clicks will do nothing. With this call, you make those
6099     * subsequent clicks also to issue the selection callbacks.
6100     *
6101     * @note <b>Double clicks</b> will @b always be reported on items.
6102     *
6103     * @see elm_gengrid_always_select_mode_get()
6104     *
6105     * @ingroup Gengrid
6106     */
6107    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6108
6109    /**
6110     * Get whether items on a given gengrid widget have their selection
6111     * callbacks issued for @b every subsequent selection click on them
6112     * or just for the first click.
6113     *
6114     * @param obj The gengrid object.
6115     * @return @c EINA_TRUE if the gengrid items are "always selected",
6116     * @c EINA_FALSE, otherwise
6117     *
6118     * @see elm_gengrid_always_select_mode_set() for more details
6119     *
6120     * @ingroup Gengrid
6121     */
6122    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6123
6124    /**
6125     * Set whether items on a given gengrid widget can be selected or not.
6126     *
6127     * @param obj The gengrid object
6128     * @param no_select @c EINA_TRUE to make items selectable,
6129     * @c EINA_FALSE otherwise
6130     *
6131     * This will make items in @p obj selectable or not. In the latter
6132     * case, any user interacion on the gendrid items will neither make
6133     * them appear selected nor them call their selection callback
6134     * functions.
6135     *
6136     * @see elm_gengrid_no_select_mode_get()
6137     *
6138     * @ingroup Gengrid
6139     */
6140    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6141
6142    /**
6143     * Get whether items on a given gengrid widget can be selected or
6144     * not.
6145     *
6146     * @param obj The gengrid object
6147     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6148     * otherwise
6149     *
6150     * @see elm_gengrid_no_select_mode_set() for more details
6151     *
6152     * @ingroup Gengrid
6153     */
6154    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6155
6156    /**
6157     * Enable or disable multi-selection in a given gengrid widget
6158     *
6159     * @param obj The gengrid object.
6160     * @param multi @c EINA_TRUE, to enable multi-selection,
6161     * @c EINA_FALSE to disable it.
6162     *
6163     * Multi-selection is the ability for one to have @b more than one
6164     * item selected, on a given gengrid, simultaneously. When it is
6165     * enabled, a sequence of clicks on different items will make them
6166     * all selected, progressively. A click on an already selected item
6167     * will unselect it. If interecting via the keyboard,
6168     * multi-selection is enabled while holding the "Shift" key.
6169     *
6170     * @note By default, multi-selection is @b disabled on gengrids
6171     *
6172     * @see elm_gengrid_multi_select_get()
6173     *
6174     * @ingroup Gengrid
6175     */
6176    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6177
6178    /**
6179     * Get whether multi-selection is enabled or disabled for a given
6180     * gengrid widget
6181     *
6182     * @param obj The gengrid object.
6183     * @return @c EINA_TRUE, if multi-selection is enabled, @c
6184     * EINA_FALSE otherwise
6185     *
6186     * @see elm_gengrid_multi_select_set() for more details
6187     *
6188     * @ingroup Gengrid
6189     */
6190    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6191
6192    /**
6193     * Enable or disable bouncing effect for a given gengrid widget
6194     *
6195     * @param obj The gengrid object
6196     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6197     * @c EINA_FALSE to disable it
6198     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6199     * @c EINA_FALSE to disable it
6200     *
6201     * The bouncing effect occurs whenever one reaches the gengrid's
6202     * edge's while panning it -- it will scroll past its limits a
6203     * little bit and return to the edge again, in a animated for,
6204     * automatically.
6205     *
6206     * @note By default, gengrids have bouncing enabled on both axis
6207     *
6208     * @see elm_gengrid_bounce_get()
6209     *
6210     * @ingroup Gengrid
6211     */
6212    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6213
6214    /**
6215     * Get whether bouncing effects are enabled or disabled, for a
6216     * given gengrid widget, on each axis
6217     *
6218     * @param obj The gengrid object
6219     * @param h_bounce Pointer to a variable where to store the
6220     * horizontal bouncing flag.
6221     * @param v_bounce Pointer to a variable where to store the
6222     * vertical bouncing flag.
6223     *
6224     * @see elm_gengrid_bounce_set() for more details
6225     *
6226     * @ingroup Gengrid
6227     */
6228    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6229
6230    /**
6231     * Set a given gengrid widget's scrolling page size, relative to
6232     * its viewport size.
6233     *
6234     * @param obj The gengrid object
6235     * @param h_pagerel The horizontal page (relative) size
6236     * @param v_pagerel The vertical page (relative) size
6237     *
6238     * The gengrid's scroller is capable of binding scrolling by the
6239     * user to "pages". It means that, while scrolling and, specially
6240     * after releasing the mouse button, the grid will @b snap to the
6241     * nearest displaying page's area. When page sizes are set, the
6242     * grid's continuous content area is split into (equal) page sized
6243     * pieces.
6244     *
6245     * This function sets the size of a page <b>relatively to the
6246     * viewport dimensions</b> of the gengrid, for each axis. A value
6247     * @c 1.0 means "the exact viewport's size", in that axis, while @c
6248     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6249     * a viewport". Sane usable values are, than, between @c 0.0 and @c
6250     * 1.0. Values beyond those will make it behave behave
6251     * inconsistently. If you only want one axis to snap to pages, use
6252     * the value @c 0.0 for the other one.
6253     *
6254     * There is a function setting page size values in @b absolute
6255     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6256     * is mutually exclusive to this one.
6257     *
6258     * @see elm_gengrid_page_relative_get()
6259     *
6260     * @ingroup Gengrid
6261     */
6262    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6263
6264    /**
6265     * Get a given gengrid widget's scrolling page size, relative to
6266     * its viewport size.
6267     *
6268     * @param obj The gengrid object
6269     * @param h_pagerel Pointer to a variable where to store the
6270     * horizontal page (relative) size
6271     * @param v_pagerel Pointer to a variable where to store the
6272     * vertical page (relative) size
6273     *
6274     * @see elm_gengrid_page_relative_set() for more details
6275     *
6276     * @ingroup Gengrid
6277     */
6278    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6279
6280    /**
6281     * Set a given gengrid widget's scrolling page size
6282     *
6283     * @param obj The gengrid object
6284     * @param h_pagerel The horizontal page size, in pixels
6285     * @param v_pagerel The vertical page size, in pixels
6286     *
6287     * The gengrid's scroller is capable of binding scrolling by the
6288     * user to "pages". It means that, while scrolling and, specially
6289     * after releasing the mouse button, the grid will @b snap to the
6290     * nearest displaying page's area. When page sizes are set, the
6291     * grid's continuous content area is split into (equal) page sized
6292     * pieces.
6293     *
6294     * This function sets the size of a page of the gengrid, in pixels,
6295     * for each axis. Sane usable values are, between @c 0 and the
6296     * dimensions of @p obj, for each axis. Values beyond those will
6297     * make it behave behave inconsistently. If you only want one axis
6298     * to snap to pages, use the value @c 0 for the other one.
6299     *
6300     * There is a function setting page size values in @b relative
6301     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6302     * use is mutually exclusive to this one.
6303     *
6304     * @ingroup Gengrid
6305     */
6306    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6307
6308    /**
6309     * Set for what direction a given gengrid widget will expand while
6310     * placing its items.
6311     *
6312     * @param obj The gengrid object.
6313     * @param setting @c EINA_TRUE to make the gengrid expand
6314     * horizontally, @c EINA_FALSE to expand vertically.
6315     *
6316     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6317     * in @b columns, from top to bottom and, when the space for a
6318     * column is filled, another one is started on the right, thus
6319     * expanding the grid horizontally. When in "vertical mode"
6320     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6321     * to right and, when the space for a row is filled, another one is
6322     * started below, thus expanding the grid vertically.
6323     *
6324     * @see elm_gengrid_horizontal_get()
6325     *
6326     * @ingroup Gengrid
6327     */
6328    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6329
6330    /**
6331     * Get for what direction a given gengrid widget will expand while
6332     * placing its items.
6333     *
6334     * @param obj The gengrid object.
6335     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6336     * @c EINA_FALSE if it's set to expand vertically.
6337     *
6338     * @see elm_gengrid_horizontal_set() for more detais
6339     *
6340     * @ingroup Gengrid
6341     */
6342    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6343
6344    /**
6345     * Get the first item in a given gengrid widget
6346     *
6347     * @param obj The gengrid object
6348     * @return The first item's handle or @c NULL, if there are no
6349     * items in @p obj (and on errors)
6350     *
6351     * This returns the first item in the @p obj's internal list of
6352     * items.
6353     *
6354     * @see elm_gengrid_last_item_get()
6355     *
6356     * @ingroup Gengrid
6357     */
6358    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6359
6360    /**
6361     * Get the last item in a given gengrid widget
6362     *
6363     * @param obj The gengrid object
6364     * @return The last item's handle or @c NULL, if there are no
6365     * items in @p obj (and on errors)
6366     *
6367     * This returns the last item in the @p obj's internal list of
6368     * items.
6369     *
6370     * @see elm_gengrid_first_item_get()
6371     *
6372     * @ingroup Gengrid
6373     */
6374    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6375
6376    /**
6377     * Get the @b next item in a gengrid widget's internal list of items,
6378     * given a handle to one of those items.
6379     *
6380     * @param item The gengrid item to fetch next from
6381     * @return The item after @p item, or @c NULL if there's none (and
6382     * on errors)
6383     *
6384     * This returns the item placed after the @p item, on the container
6385     * gengrid.
6386     *
6387     * @see elm_gengrid_item_prev_get()
6388     *
6389     * @ingroup Gengrid
6390     */
6391    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6392
6393    /**
6394     * Get the @b previous item in a gengrid widget's internal list of items,
6395     * given a handle to one of those items.
6396     *
6397     * @param item The gengrid item to fetch previous from
6398     * @return The item before @p item, or @c NULL if there's none (and
6399     * on errors)
6400     *
6401     * This returns the item placed before the @p item, on the container
6402     * gengrid.
6403     *
6404     * @see elm_gengrid_item_next_get()
6405     *
6406     * @ingroup Gengrid
6407     */
6408    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6409
6410    /**
6411     * Get the gengrid object's handle which contains a given gengrid
6412     * item
6413     *
6414     * @param item The item to fetch the container from
6415     * @return The gengrid (parent) object
6416     *
6417     * This returns the gengrid object itself that an item belongs to.
6418     *
6419     * @ingroup Gengrid
6420     */
6421    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6422
6423    /**
6424     * Remove a gengrid item from the its parent, deleting it.
6425     *
6426     * @param item The item to be removed.
6427     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6428     *
6429     * @see elm_gengrid_clear(), to remove all items in a gengrid at
6430     * once.
6431     *
6432     * @ingroup Gengrid
6433     */
6434    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6435
6436    /**
6437     * Update the contents of a given gengrid item
6438     *
6439     * @param item The gengrid item
6440     *
6441     * This updates an item by calling all the item class functions
6442     * again to get the icons, labels and states. Use this when the
6443     * original item data has changed and you want thta changes to be
6444     * reflected.
6445     *
6446     * @ingroup Gengrid
6447     */
6448    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6449    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6450    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6451
6452    /**
6453     * Return the data associated to a given gengrid item
6454     *
6455     * @param item The gengrid item.
6456     * @return the data associated to this item.
6457     *
6458     * This returns the @c data value passed on the
6459     * elm_gengrid_item_append() and related item addition calls.
6460     *
6461     * @see elm_gengrid_item_append()
6462     * @see elm_gengrid_item_data_set()
6463     *
6464     * @ingroup Gengrid
6465     */
6466    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6467
6468    /**
6469     * Set the data associated to a given gengrid item
6470     *
6471     * @param item The gengrid item
6472     * @param data The new data pointer to set on it
6473     *
6474     * This @b overrides the @c data value passed on the
6475     * elm_gengrid_item_append() and related item addition calls. This
6476     * function @b won't call elm_gengrid_item_update() automatically,
6477     * so you'd issue it afterwards if you want to hove the item
6478     * updated to reflect the that new data.
6479     *
6480     * @see elm_gengrid_item_data_get()
6481     *
6482     * @ingroup Gengrid
6483     */
6484    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6485
6486    /**
6487     * Get a given gengrid item's position, relative to the whole
6488     * gengrid's grid area.
6489     *
6490     * @param item The Gengrid item.
6491     * @param x Pointer to variable where to store the item's <b>row
6492     * number</b>.
6493     * @param y Pointer to variable where to store the item's <b>column
6494     * number</b>.
6495     *
6496     * This returns the "logical" position of the item whithin the
6497     * gengrid. For example, @c (0, 1) would stand for first row,
6498     * second column.
6499     *
6500     * @ingroup Gengrid
6501     */
6502    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6503
6504    /**
6505     * Set whether a given gengrid item is selected or not
6506     *
6507     * @param item The gengrid item
6508     * @param selected Use @c EINA_TRUE, to make it selected, @c
6509     * EINA_FALSE to make it unselected
6510     *
6511     * This sets the selected state of an item. If multi selection is
6512     * not enabled on the containing gengrid and @p selected is @c
6513     * EINA_TRUE, any other previously selected items will get
6514     * unselected in favor of this new one.
6515     *
6516     * @see elm_gengrid_item_selected_get()
6517     *
6518     * @ingroup Gengrid
6519     */
6520    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6521
6522    /**
6523     * Get whether a given gengrid item is selected or not
6524     *
6525     * @param item The gengrid item
6526     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6527     *
6528     * @see elm_gengrid_item_selected_set() for more details
6529     *
6530     * @ingroup Gengrid
6531     */
6532    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6533
6534    /**
6535     * Get the real Evas object created to implement the view of a
6536     * given gengrid item
6537     *
6538     * @param item The gengrid item.
6539     * @return the Evas object implementing this item's view.
6540     *
6541     * This returns the actual Evas object used to implement the
6542     * specified gengrid item's view. This may be @c NULL, as it may
6543     * not have been created or may have been deleted, at any time, by
6544     * the gengrid. <b>Do not modify this object</b> (move, resize,
6545     * show, hide, etc.), as the gengrid is controlling it. This
6546     * function is for querying, emitting custom signals or hooking
6547     * lower level callbacks for events on that object. Do not delete
6548     * this object under any circumstances.
6549     *
6550     * @see elm_gengrid_item_data_get()
6551     *
6552     * @ingroup Gengrid
6553     */
6554    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6555
6556    /**
6557     * Show the portion of a gengrid's internal grid containing a given
6558     * item, @b immediately.
6559     *
6560     * @param item The item to display
6561     *
6562     * This causes gengrid to @b redraw its viewport's contents to the
6563     * region contining the given @p item item, if it is not fully
6564     * visible.
6565     *
6566     * @see elm_gengrid_item_bring_in()
6567     *
6568     * @ingroup Gengrid
6569     */
6570    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6571
6572    /**
6573     * Animatedly bring in, to the visible are of a gengrid, a given
6574     * item on it.
6575     *
6576     * @param item The gengrid item to display
6577     *
6578     * This causes gengrig to jump to the given @p item item and show
6579     * it (by scrolling), if it is not fully visible. This will use
6580     * animation to do so and take a period of time to complete.
6581     *
6582     * @see elm_gengrid_item_show()
6583     *
6584     * @ingroup Gengrid
6585     */
6586    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6587
6588    /**
6589     * Set whether a given gengrid item is disabled or not.
6590     *
6591     * @param item The gengrid item
6592     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6593     * to enable it back.
6594     *
6595     * A disabled item cannot be selected or unselected. It will also
6596     * change its appearance, to signal the user it's disabled.
6597     *
6598     * @see elm_gengrid_item_disabled_get()
6599     *
6600     * @ingroup Gengrid
6601     */
6602    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6603
6604    /**
6605     * Get whether a given gengrid item is disabled or not.
6606     *
6607     * @param item The gengrid item
6608     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6609     * (and on errors).
6610     *
6611     * @see elm_gengrid_item_disabled_set() for more details
6612     *
6613     * @ingroup Gengrid
6614     */
6615    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6616
6617    /**
6618     * Set the text to be shown in a given gengrid item's tooltips.
6619     *
6620     * @param item The gengrid item
6621     * @param text The text to set in the content
6622     *
6623     * This call will setup the text to be used as tooltip to that item
6624     * (analogous to elm_object_tooltip_text_set(), but being item
6625     * tooltips with higher precedence than object tooltips). It can
6626     * have only one tooltip at a time, so any previous tooltip data
6627     * will get removed.
6628     *
6629     * @ingroup Gengrid
6630     */
6631    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6632
6633    /**
6634     * Set the content to be shown in a given gengrid item's tooltips
6635     *
6636     * @param item The gengrid item.
6637     * @param func The function returning the tooltip contents.
6638     * @param data What to provide to @a func as callback data/context.
6639     * @param del_cb Called when data is not needed anymore, either when
6640     *        another callback replaces @p func, the tooltip is unset with
6641     *        elm_gengrid_item_tooltip_unset() or the owner @p item
6642     *        dies. This callback receives as its first parameter the
6643     *        given @p data, being @c event_info the item handle.
6644     *
6645     * This call will setup the tooltip's contents to @p item
6646     * (analogous to elm_object_tooltip_content_cb_set(), but being
6647     * item tooltips with higher precedence than object tooltips). It
6648     * can have only one tooltip at a time, so any previous tooltip
6649     * content will get removed. @p func (with @p data) will be called
6650     * every time Elementary needs to show the tooltip and it should
6651     * return a valid Evas object, which will be fully managed by the
6652     * tooltip system, getting deleted when the tooltip is gone.
6653     *
6654     * @ingroup Gengrid
6655     */
6656    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);
6657
6658    /**
6659     * Unset a tooltip from a given gengrid item
6660     *
6661     * @param item gengrid item to remove a previously set tooltip from.
6662     *
6663     * This call removes any tooltip set on @p item. The callback
6664     * provided as @c del_cb to
6665     * elm_gengrid_item_tooltip_content_cb_set() will be called to
6666     * notify it is not used anymore (and have resources cleaned, if
6667     * need be).
6668     *
6669     * @see elm_gengrid_item_tooltip_content_cb_set()
6670     *
6671     * @ingroup Gengrid
6672     */
6673    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6674
6675    /**
6676     * Set a different @b style for a given gengrid item's tooltip.
6677     *
6678     * @param item gengrid item with tooltip set
6679     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6680     * "default", @c "transparent", etc)
6681     *
6682     * Tooltips can have <b>alternate styles</b> to be displayed on,
6683     * which are defined by the theme set on Elementary. This function
6684     * works analogously as elm_object_tooltip_style_set(), but here
6685     * applied only to gengrid item objects. The default style for
6686     * tooltips is @c "default".
6687     *
6688     * @note before you set a style you should define a tooltip with
6689     *       elm_gengrid_item_tooltip_content_cb_set() or
6690     *       elm_gengrid_item_tooltip_text_set()
6691     *
6692     * @see elm_gengrid_item_tooltip_style_get()
6693     *
6694     * @ingroup Gengrid
6695     */
6696    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6697
6698    /**
6699     * Get the style set a given gengrid item's tooltip.
6700     *
6701     * @param item gengrid item with tooltip already set on.
6702     * @return style the theme style in use, which defaults to
6703     *         "default". If the object does not have a tooltip set,
6704     *         then @c NULL is returned.
6705     *
6706     * @see elm_gengrid_item_tooltip_style_set() for more details
6707     *
6708     * @ingroup Gengrid
6709     */
6710    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6711    /**
6712     * @brief Disable size restrictions on an object's tooltip
6713     * @param item The tooltip's anchor object
6714     * @param disable If EINA_TRUE, size restrictions are disabled
6715     * @return EINA_FALSE on failure, EINA_TRUE on success
6716     *
6717     * This function allows a tooltip to expand beyond its parant window's canvas.
6718     * It will instead be limited only by the size of the display.
6719     */
6720    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6721    /**
6722     * @brief Retrieve size restriction state of an object's tooltip
6723     * @param item The tooltip's anchor object
6724     * @return If EINA_TRUE, size restrictions are disabled
6725     *
6726     * This function returns whether a tooltip is allowed to expand beyond
6727     * its parant window's canvas.
6728     * It will instead be limited only by the size of the display.
6729     */
6730    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6731    /**
6732     * Set the type of mouse pointer/cursor decoration to be shown,
6733     * when the mouse pointer is over the given gengrid widget item
6734     *
6735     * @param item gengrid item to customize cursor on
6736     * @param cursor the cursor type's name
6737     *
6738     * This function works analogously as elm_object_cursor_set(), but
6739     * here the cursor's changing area is restricted to the item's
6740     * area, and not the whole widget's. Note that that item cursors
6741     * have precedence over widget cursors, so that a mouse over @p
6742     * item will always show cursor @p type.
6743     *
6744     * If this function is called twice for an object, a previously set
6745     * cursor will be unset on the second call.
6746     *
6747     * @see elm_object_cursor_set()
6748     * @see elm_gengrid_item_cursor_get()
6749     * @see elm_gengrid_item_cursor_unset()
6750     *
6751     * @ingroup Gengrid
6752     */
6753    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6754
6755    /**
6756     * Get the type of mouse pointer/cursor decoration set to be shown,
6757     * when the mouse pointer is over the given gengrid widget item
6758     *
6759     * @param item gengrid item with custom cursor set
6760     * @return the cursor type's name or @c NULL, if no custom cursors
6761     * were set to @p item (and on errors)
6762     *
6763     * @see elm_object_cursor_get()
6764     * @see elm_gengrid_item_cursor_set() for more details
6765     * @see elm_gengrid_item_cursor_unset()
6766     *
6767     * @ingroup Gengrid
6768     */
6769    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6770
6771    /**
6772     * Unset any custom mouse pointer/cursor decoration set to be
6773     * shown, when the mouse pointer is over the given gengrid widget
6774     * item, thus making it show the @b default cursor again.
6775     *
6776     * @param item a gengrid item
6777     *
6778     * Use this call to undo any custom settings on this item's cursor
6779     * decoration, bringing it back to defaults (no custom style set).
6780     *
6781     * @see elm_object_cursor_unset()
6782     * @see elm_gengrid_item_cursor_set() for more details
6783     *
6784     * @ingroup Gengrid
6785     */
6786    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6787
6788    /**
6789     * Set a different @b style for a given custom cursor set for a
6790     * gengrid item.
6791     *
6792     * @param item gengrid item with custom cursor set
6793     * @param style the <b>theme style</b> to use (e.g. @c "default",
6794     * @c "transparent", etc)
6795     *
6796     * This function only makes sense when one is using custom mouse
6797     * cursor decorations <b>defined in a theme file</b> , which can
6798     * have, given a cursor name/type, <b>alternate styles</b> on
6799     * it. It works analogously as elm_object_cursor_style_set(), but
6800     * here applied only to gengrid item objects.
6801     *
6802     * @warning Before you set a cursor style you should have defined a
6803     *       custom cursor previously on the item, with
6804     *       elm_gengrid_item_cursor_set()
6805     *
6806     * @see elm_gengrid_item_cursor_engine_only_set()
6807     * @see elm_gengrid_item_cursor_style_get()
6808     *
6809     * @ingroup Gengrid
6810     */
6811    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6812
6813    /**
6814     * Get the current @b style set for a given gengrid item's custom
6815     * cursor
6816     *
6817     * @param item gengrid item with custom cursor set.
6818     * @return style the cursor style in use. If the object does not
6819     *         have a cursor set, then @c NULL is returned.
6820     *
6821     * @see elm_gengrid_item_cursor_style_set() for more details
6822     *
6823     * @ingroup Gengrid
6824     */
6825    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6826
6827    /**
6828     * Set if the (custom) cursor for a given gengrid item should be
6829     * searched in its theme, also, or should only rely on the
6830     * rendering engine.
6831     *
6832     * @param item item with custom (custom) cursor already set on
6833     * @param engine_only Use @c EINA_TRUE to have cursors looked for
6834     * only on those provided by the rendering engine, @c EINA_FALSE to
6835     * have them searched on the widget's theme, as well.
6836     *
6837     * @note This call is of use only if you've set a custom cursor
6838     * for gengrid items, with elm_gengrid_item_cursor_set().
6839     *
6840     * @note By default, cursors will only be looked for between those
6841     * provided by the rendering engine.
6842     *
6843     * @ingroup Gengrid
6844     */
6845    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6846
6847    /**
6848     * Get if the (custom) cursor for a given gengrid item is being
6849     * searched in its theme, also, or is only relying on the rendering
6850     * engine.
6851     *
6852     * @param item a gengrid item
6853     * @return @c EINA_TRUE, if cursors are being looked for only on
6854     * those provided by the rendering engine, @c EINA_FALSE if they
6855     * are being searched on the widget's theme, as well.
6856     *
6857     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
6858     *
6859     * @ingroup Gengrid
6860     */
6861    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6862
6863    /**
6864     * Remove all items from a given gengrid widget
6865     *
6866     * @param obj The gengrid object.
6867     *
6868     * This removes (and deletes) all items in @p obj, leaving it
6869     * empty.
6870     *
6871     * @see elm_gengrid_item_del(), to remove just one item.
6872     *
6873     * @ingroup Gengrid
6874     */
6875    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6876
6877    /**
6878     * Get the selected item in a given gengrid widget
6879     *
6880     * @param obj The gengrid object.
6881     * @return The selected item's handleor @c NULL, if none is
6882     * selected at the moment (and on errors)
6883     *
6884     * This returns the selected item in @p obj. If multi selection is
6885     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
6886     * the first item in the list is selected, which might not be very
6887     * useful. For that case, see elm_gengrid_selected_items_get().
6888     *
6889     * @ingroup Gengrid
6890     */
6891    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6892
6893    /**
6894     * Get <b>a list</b> of selected items in a given gengrid
6895     *
6896     * @param obj The gengrid object.
6897     * @return The list of selected items or @c NULL, if none is
6898     * selected at the moment (and on errors)
6899     *
6900     * This returns a list of the selected items, in the order that
6901     * they appear in the grid. This list is only valid as long as no
6902     * more items are selected or unselected (or unselected implictly
6903     * by deletion). The list contains #Elm_Gengrid_Item pointers as
6904     * data, naturally.
6905     *
6906     * @see elm_gengrid_selected_item_get()
6907     *
6908     * @ingroup Gengrid
6909     */
6910    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6911
6912    /**
6913     * @}
6914     */
6915
6916    /**
6917     * @defgroup Clock Clock
6918     *
6919     * @image html img/widget/clock/preview-00.png
6920     * @image latex img/widget/clock/preview-00.eps
6921     *
6922     * This is a @b digital clock widget. In its default theme, it has a
6923     * vintage "flipping numbers clock" appearance, which will animate
6924     * sheets of individual algarisms individually as time goes by.
6925     *
6926     * A newly created clock will fetch system's time (already
6927     * considering local time adjustments) to start with, and will tick
6928     * accondingly. It may or may not show seconds.
6929     *
6930     * Clocks have an @b edition mode. When in it, the sheets will
6931     * display extra arrow indications on the top and bottom and the
6932     * user may click on them to raise or lower the time values. After
6933     * it's told to exit edition mode, it will keep ticking with that
6934     * new time set (it keeps the difference from local time).
6935     *
6936     * Also, when under edition mode, user clicks on the cited arrows
6937     * which are @b held for some time will make the clock to flip the
6938     * sheet, thus editing the time, continuosly and automatically for
6939     * the user. The interval between sheet flips will keep growing in
6940     * time, so that it helps the user to reach a time which is distant
6941     * from the one set.
6942     *
6943     * The time display is, by default, in military mode (24h), but an
6944     * am/pm indicator may be optionally shown, too, when it will
6945     * switch to 12h.
6946     *
6947     * Smart callbacks one can register to:
6948     * - "changed" - the clock's user changed the time
6949     *
6950     * Here is an example on its usage:
6951     * @li @ref clock_example
6952     */
6953
6954    /**
6955     * @addtogroup Clock
6956     * @{
6957     */
6958
6959    /**
6960     * Identifiers for which clock digits should be editable, when a
6961     * clock widget is in edition mode. Values may be ORed together to
6962     * make a mask, naturally.
6963     *
6964     * @see elm_clock_edit_set()
6965     * @see elm_clock_digit_edit_set()
6966     */
6967    typedef enum _Elm_Clock_Digedit
6968      {
6969         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
6970         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
6971         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
6972         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
6973         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
6974         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
6975         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
6976         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
6977      } Elm_Clock_Digedit;
6978
6979    /**
6980     * Add a new clock widget to the given parent Elementary
6981     * (container) object
6982     *
6983     * @param parent The parent object
6984     * @return a new clock widget handle or @c NULL, on errors
6985     *
6986     * This function inserts a new clock widget on the canvas.
6987     *
6988     * @ingroup Clock
6989     */
6990    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6991
6992    /**
6993     * Set a clock widget's time, programmatically
6994     *
6995     * @param obj The clock widget object
6996     * @param hrs The hours to set
6997     * @param min The minutes to set
6998     * @param sec The secondes to set
6999     *
7000     * This function updates the time that is showed by the clock
7001     * widget.
7002     *
7003     *  Values @b must be set within the following ranges:
7004     * - 0 - 23, for hours
7005     * - 0 - 59, for minutes
7006     * - 0 - 59, for seconds,
7007     *
7008     * even if the clock is not in "military" mode.
7009     *
7010     * @warning The behavior for values set out of those ranges is @b
7011     * indefined.
7012     *
7013     * @ingroup Clock
7014     */
7015    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7016
7017    /**
7018     * Get a clock widget's time values
7019     *
7020     * @param obj The clock object
7021     * @param[out] hrs Pointer to the variable to get the hours value
7022     * @param[out] min Pointer to the variable to get the minutes value
7023     * @param[out] sec Pointer to the variable to get the seconds value
7024     *
7025     * This function gets the time set for @p obj, returning
7026     * it on the variables passed as the arguments to function
7027     *
7028     * @note Use @c NULL pointers on the time values you're not
7029     * interested in: they'll be ignored by the function.
7030     *
7031     * @ingroup Clock
7032     */
7033    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7034
7035    /**
7036     * Set whether a given clock widget is under <b>edition mode</b> or
7037     * under (default) displaying-only mode.
7038     *
7039     * @param obj The clock object
7040     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7041     * put it back to "displaying only" mode
7042     *
7043     * This function makes a clock's time to be editable or not <b>by
7044     * user interaction</b>. When in edition mode, clocks @b stop
7045     * ticking, until one brings them back to canonical mode. The
7046     * elm_clock_digit_edit_set() function will influence which digits
7047     * of the clock will be editable. By default, all of them will be
7048     * (#ELM_CLOCK_NONE).
7049     *
7050     * @note am/pm sheets, if being shown, will @b always be editable
7051     * under edition mode.
7052     *
7053     * @see elm_clock_edit_get()
7054     *
7055     * @ingroup Clock
7056     */
7057    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7058
7059    /**
7060     * Retrieve whether a given clock widget is under <b>edition
7061     * mode</b> or under (default) displaying-only mode.
7062     *
7063     * @param obj The clock object
7064     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7065     * otherwise
7066     *
7067     * This function retrieves whether the clock's time can be edited
7068     * or not by user interaction.
7069     *
7070     * @see elm_clock_edit_set() for more details
7071     *
7072     * @ingroup Clock
7073     */
7074    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7075
7076    /**
7077     * Set what digits of the given clock widget should be editable
7078     * when in edition mode.
7079     *
7080     * @param obj The clock object
7081     * @param digedit Bit mask indicating the digits to be editable
7082     * (values in #Elm_Clock_Digedit).
7083     *
7084     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7085     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7086     * EINA_FALSE).
7087     *
7088     * @see elm_clock_digit_edit_get()
7089     *
7090     * @ingroup Clock
7091     */
7092    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7093
7094    /**
7095     * Retrieve what digits of the given clock widget should be
7096     * editable when in edition mode.
7097     *
7098     * @param obj The clock object
7099     * @return Bit mask indicating the digits to be editable
7100     * (values in #Elm_Clock_Digedit).
7101     *
7102     * @see elm_clock_digit_edit_set() for more details
7103     *
7104     * @ingroup Clock
7105     */
7106    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7107
7108    /**
7109     * Set if the given clock widget must show hours in military or
7110     * am/pm mode
7111     *
7112     * @param obj The clock object
7113     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7114     * to military mode
7115     *
7116     * This function sets if the clock must show hours in military or
7117     * am/pm mode. In some countries like Brazil the military mode
7118     * (00-24h-format) is used, in opposition to the USA, where the
7119     * am/pm mode is more commonly used.
7120     *
7121     * @see elm_clock_show_am_pm_get()
7122     *
7123     * @ingroup Clock
7124     */
7125    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7126
7127    /**
7128     * Get if the given clock widget shows hours in military or am/pm
7129     * mode
7130     *
7131     * @param obj The clock object
7132     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7133     * military
7134     *
7135     * This function gets if the clock shows hours in military or am/pm
7136     * mode.
7137     *
7138     * @see elm_clock_show_am_pm_set() for more details
7139     *
7140     * @ingroup Clock
7141     */
7142    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7143
7144    /**
7145     * Set if the given clock widget must show time with seconds or not
7146     *
7147     * @param obj The clock object
7148     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7149     *
7150     * This function sets if the given clock must show or not elapsed
7151     * seconds. By default, they are @b not shown.
7152     *
7153     * @see elm_clock_show_seconds_get()
7154     *
7155     * @ingroup Clock
7156     */
7157    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7158
7159    /**
7160     * Get whether the given clock widget is showing time with seconds
7161     * or not
7162     *
7163     * @param obj The clock object
7164     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7165     *
7166     * This function gets whether @p obj is showing or not the elapsed
7167     * seconds.
7168     *
7169     * @see elm_clock_show_seconds_set()
7170     *
7171     * @ingroup Clock
7172     */
7173    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7174
7175    /**
7176     * Set the interval on time updates for an user mouse button hold
7177     * on clock widgets' time edition.
7178     *
7179     * @param obj The clock object
7180     * @param interval The (first) interval value in seconds
7181     *
7182     * This interval value is @b decreased while the user holds the
7183     * mouse pointer either incrementing or decrementing a given the
7184     * clock digit's value.
7185     *
7186     * This helps the user to get to a given time distant from the
7187     * current one easier/faster, as it will start to flip quicker and
7188     * quicker on mouse button holds.
7189     *
7190     * The calculation for the next flip interval value, starting from
7191     * the one set with this call, is the previous interval divided by
7192     * 1.05, so it decreases a little bit.
7193     *
7194     * The default starting interval value for automatic flips is
7195     * @b 0.85 seconds.
7196     *
7197     * @see elm_clock_interval_get()
7198     *
7199     * @ingroup Clock
7200     */
7201    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7202
7203    /**
7204     * Get the interval on time updates for an user mouse button hold
7205     * on clock widgets' time edition.
7206     *
7207     * @param obj The clock object
7208     * @return The (first) interval value, in seconds, set on it
7209     *
7210     * @see elm_clock_interval_set() for more details
7211     *
7212     * @ingroup Clock
7213     */
7214    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7215
7216    /**
7217     * @}
7218     */
7219
7220    /**
7221     * @defgroup Layout Layout
7222     *
7223     * @image html img/widget/layout/preview-00.png
7224     * @image latex img/widget/layout/preview-00.eps width=\textwidth
7225     *
7226     * @image html img/layout-predefined.png
7227     * @image latex img/layout-predefined.eps width=\textwidth
7228     *
7229     * This is a container widget that takes a standard Edje design file and
7230     * wraps it very thinly in a widget.
7231     *
7232     * An Edje design (theme) file has a very wide range of possibilities to
7233     * describe the behavior of elements added to the Layout. Check out the Edje
7234     * documentation and the EDC reference to get more information about what can
7235     * be done with Edje.
7236     *
7237     * Just like @ref List, @ref Box, and other container widgets, any
7238     * object added to the Layout will become its child, meaning that it will be
7239     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7240     *
7241     * The Layout widget can contain as many Contents, Boxes or Tables as
7242     * described in its theme file. For instance, objects can be added to
7243     * different Tables by specifying the respective Table part names. The same
7244     * is valid for Content and Box.
7245     *
7246     * The objects added as child of the Layout will behave as described in the
7247     * part description where they were added. There are 3 possible types of
7248     * parts where a child can be added:
7249     *
7250     * @section secContent Content (SWALLOW part)
7251     *
7252     * Only one object can be added to the @c SWALLOW part (but you still can
7253     * have many @c SWALLOW parts and one object on each of them). Use the @c
7254     * elm_layout_content_* set of functions to set, retrieve and unset objects
7255     * as content of the @c SWALLOW. After being set to this part, the object
7256     * size, position, visibility, clipping and other description properties
7257     * will be totally controled by the description of the given part (inside
7258     * the Edje theme file).
7259     *
7260     * One can use @c evas_object_size_hint_* functions on the child to have some
7261     * kind of control over its behavior, but the resulting behavior will still
7262     * depend heavily on the @c SWALLOW part description.
7263     *
7264     * The Edje theme also can change the part description, based on signals or
7265     * scripts running inside the theme. This change can also be animated. All of
7266     * this will affect the child object set as content accordingly. The object
7267     * size will be changed if the part size is changed, it will animate move if
7268     * the part is moving, and so on.
7269     *
7270     * The following picture demonstrates a Layout widget with a child object
7271     * added to its @c SWALLOW:
7272     *
7273     * @image html layout_swallow.png
7274     * @image latex layout_swallow.eps width=\textwidth
7275     *
7276     * @section secBox Box (BOX part)
7277     *
7278     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7279     * allows one to add objects to the box and have them distributed along its
7280     * area, accordingly to the specified @a layout property (now by @a layout we
7281     * mean the chosen layouting design of the Box, not the Layout widget
7282     * itself).
7283     *
7284     * A similar effect for having a box with its position, size and other things
7285     * controled by the Layout theme would be to create an Elementary @ref Box
7286     * widget and add it as a Content in the @c SWALLOW part.
7287     *
7288     * The main difference of using the Layout Box is that its behavior, the box
7289     * properties like layouting format, padding, align, etc. will be all
7290     * controled by the theme. This means, for example, that a signal could be
7291     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7292     * handled the signal by changing the box padding, or align, or both. Using
7293     * the Elementary @ref Box widget is not necessarily harder or easier, it
7294     * just depends on the circunstances and requirements.
7295     *
7296     * The Layout Box can be used through the @c elm_layout_box_* set of
7297     * functions.
7298     *
7299     * The following picture demonstrates a Layout widget with many child objects
7300     * added to its @c BOX part:
7301     *
7302     * @image html layout_box.png
7303     * @image latex layout_box.eps width=\textwidth
7304     *
7305     * @section secTable Table (TABLE part)
7306     *
7307     * Just like the @ref secBox, the Layout Table is very similar to the
7308     * Elementary @ref Table widget. It allows one to add objects to the Table
7309     * specifying the row and column where the object should be added, and any
7310     * column or row span if necessary.
7311     *
7312     * Again, we could have this design by adding a @ref Table widget to the @c
7313     * SWALLOW part using elm_layout_content_set(). The same difference happens
7314     * here when choosing to use the Layout Table (a @c TABLE part) instead of
7315     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7316     *
7317     * The Layout Table can be used through the @c elm_layout_table_* set of
7318     * functions.
7319     *
7320     * The following picture demonstrates a Layout widget with many child objects
7321     * added to its @c TABLE part:
7322     *
7323     * @image html layout_table.png
7324     * @image latex layout_table.eps width=\textwidth
7325     *
7326     * @section secPredef Predefined Layouts
7327     *
7328     * Another interesting thing about the Layout widget is that it offers some
7329     * predefined themes that come with the default Elementary theme. These
7330     * themes can be set by the call elm_layout_theme_set(), and provide some
7331     * basic functionality depending on the theme used.
7332     *
7333     * Most of them already send some signals, some already provide a toolbar or
7334     * back and next buttons.
7335     *
7336     * These are available predefined theme layouts. All of them have class = @c
7337     * layout, group = @c application, and style = one of the following options:
7338     *
7339     * @li @c toolbar-content - application with toolbar and main content area
7340     * @li @c toolbar-content-back - application with toolbar and main content
7341     * area with a back button and title area
7342     * @li @c toolbar-content-back-next - application with toolbar and main
7343     * content area with a back and next buttons and title area
7344     * @li @c content-back - application with a main content area with a back
7345     * button and title area
7346     * @li @c content-back-next - application with a main content area with a
7347     * back and next buttons and title area
7348     * @li @c toolbar-vbox - application with toolbar and main content area as a
7349     * vertical box
7350     * @li @c toolbar-table - application with toolbar and main content area as a
7351     * table
7352     *
7353     * @section secExamples Examples
7354     *
7355     * Some examples of the Layout widget can be found here:
7356     * @li @ref layout_example_01
7357     * @li @ref layout_example_02
7358     * @li @ref layout_example_03
7359     * @li @ref layout_example_edc
7360     *
7361     */
7362
7363    /**
7364     * Add a new layout to the parent
7365     *
7366     * @param parent The parent object
7367     * @return The new object or NULL if it cannot be created
7368     *
7369     * @see elm_layout_file_set()
7370     * @see elm_layout_theme_set()
7371     *
7372     * @ingroup Layout
7373     */
7374    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7375    /**
7376     * Set the file that will be used as layout
7377     *
7378     * @param obj The layout object
7379     * @param file The path to file (edj) that will be used as layout
7380     * @param group The group that the layout belongs in edje file
7381     *
7382     * @return (1 = success, 0 = error)
7383     *
7384     * @ingroup Layout
7385     */
7386    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7387    /**
7388     * Set the edje group from the elementary theme that will be used as layout
7389     *
7390     * @param obj The layout object
7391     * @param clas the clas of the group
7392     * @param group the group
7393     * @param style the style to used
7394     *
7395     * @return (1 = success, 0 = error)
7396     *
7397     * @ingroup Layout
7398     */
7399    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7400    /**
7401     * Set the layout content.
7402     *
7403     * @param obj The layout object
7404     * @param swallow The swallow part name in the edje file
7405     * @param content The child that will be added in this layout object
7406     *
7407     * Once the content object is set, a previously set one will be deleted.
7408     * If you want to keep that old content object, use the
7409     * elm_layout_content_unset() function.
7410     *
7411     * @note In an Edje theme, the part used as a content container is called @c
7412     * SWALLOW. This is why the parameter name is called @p swallow, but it is
7413     * expected to be a part name just like the second parameter of
7414     * elm_layout_box_append().
7415     *
7416     * @see elm_layout_box_append()
7417     * @see elm_layout_content_get()
7418     * @see elm_layout_content_unset()
7419     * @see @ref secBox
7420     *
7421     * @ingroup Layout
7422     */
7423    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7424    /**
7425     * Get the child object in the given content part.
7426     *
7427     * @param obj The layout object
7428     * @param swallow The SWALLOW part to get its content
7429     *
7430     * @return The swallowed object or NULL if none or an error occurred
7431     *
7432     * @see elm_layout_content_set()
7433     *
7434     * @ingroup Layout
7435     */
7436    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7437    /**
7438     * Unset the layout content.
7439     *
7440     * @param obj The layout object
7441     * @param swallow The swallow part name in the edje file
7442     * @return The content that was being used
7443     *
7444     * Unparent and return the content object which was set for this part.
7445     *
7446     * @see elm_layout_content_set()
7447     *
7448     * @ingroup Layout
7449     */
7450     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7451    /**
7452     * Set the text of the given part
7453     *
7454     * @param obj The layout object
7455     * @param part The TEXT part where to set the text
7456     * @param text The text to set
7457     *
7458     * @ingroup Layout
7459     * @deprecated use elm_object_text_* instead.
7460     */
7461    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7462    /**
7463     * Get the text set in the given part
7464     *
7465     * @param obj The layout object
7466     * @param part The TEXT part to retrieve the text off
7467     *
7468     * @return The text set in @p part
7469     *
7470     * @ingroup Layout
7471     * @deprecated use elm_object_text_* instead.
7472     */
7473    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7474    /**
7475     * Append child to layout box part.
7476     *
7477     * @param obj the layout object
7478     * @param part the box part to which the object will be appended.
7479     * @param child the child object to append to box.
7480     *
7481     * Once the object is appended, it will become child of the layout. Its
7482     * lifetime will be bound to the layout, whenever the layout dies the child
7483     * will be deleted automatically. One should use elm_layout_box_remove() to
7484     * make this layout forget about the object.
7485     *
7486     * @see elm_layout_box_prepend()
7487     * @see elm_layout_box_insert_before()
7488     * @see elm_layout_box_insert_at()
7489     * @see elm_layout_box_remove()
7490     *
7491     * @ingroup Layout
7492     */
7493    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7494    /**
7495     * Prepend child to layout box part.
7496     *
7497     * @param obj the layout object
7498     * @param part the box part to prepend.
7499     * @param child the child object to prepend to box.
7500     *
7501     * Once the object is prepended, it will become child of the layout. Its
7502     * lifetime will be bound to the layout, whenever the layout dies the child
7503     * will be deleted automatically. One should use elm_layout_box_remove() to
7504     * make this layout forget about the object.
7505     *
7506     * @see elm_layout_box_append()
7507     * @see elm_layout_box_insert_before()
7508     * @see elm_layout_box_insert_at()
7509     * @see elm_layout_box_remove()
7510     *
7511     * @ingroup Layout
7512     */
7513    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7514    /**
7515     * Insert child to layout box part before a reference object.
7516     *
7517     * @param obj the layout object
7518     * @param part the box part to insert.
7519     * @param child the child object to insert into box.
7520     * @param reference another reference object to insert before in box.
7521     *
7522     * Once the object is inserted, it will become child of the layout. Its
7523     * lifetime will be bound to the layout, whenever the layout dies the child
7524     * will be deleted automatically. One should use elm_layout_box_remove() to
7525     * make this layout forget about the object.
7526     *
7527     * @see elm_layout_box_append()
7528     * @see elm_layout_box_prepend()
7529     * @see elm_layout_box_insert_before()
7530     * @see elm_layout_box_remove()
7531     *
7532     * @ingroup Layout
7533     */
7534    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7535    /**
7536     * Insert child to layout box part at a given position.
7537     *
7538     * @param obj the layout object
7539     * @param part the box part to insert.
7540     * @param child the child object to insert into box.
7541     * @param pos the numeric position >=0 to insert the child.
7542     *
7543     * Once the object is inserted, it will become child of the layout. Its
7544     * lifetime will be bound to the layout, whenever the layout dies the child
7545     * will be deleted automatically. One should use elm_layout_box_remove() to
7546     * make this layout forget about the object.
7547     *
7548     * @see elm_layout_box_append()
7549     * @see elm_layout_box_prepend()
7550     * @see elm_layout_box_insert_before()
7551     * @see elm_layout_box_remove()
7552     *
7553     * @ingroup Layout
7554     */
7555    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7556    /**
7557     * Remove a child of the given part box.
7558     *
7559     * @param obj The layout object
7560     * @param part The box part name to remove child.
7561     * @param child The object to remove from box.
7562     * @return The object that was being used, or NULL if not found.
7563     *
7564     * The object will be removed from the box part and its lifetime will
7565     * not be handled by the layout anymore. This is equivalent to
7566     * elm_layout_content_unset() for box.
7567     *
7568     * @see elm_layout_box_append()
7569     * @see elm_layout_box_remove_all()
7570     *
7571     * @ingroup Layout
7572     */
7573    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7574    /**
7575     * Remove all child of the given part box.
7576     *
7577     * @param obj The layout object
7578     * @param part The box part name to remove child.
7579     * @param clear If EINA_TRUE, then all objects will be deleted as
7580     *        well, otherwise they will just be removed and will be
7581     *        dangling on the canvas.
7582     *
7583     * The objects will be removed from the box part and their lifetime will
7584     * not be handled by the layout anymore. This is equivalent to
7585     * elm_layout_box_remove() for all box children.
7586     *
7587     * @see elm_layout_box_append()
7588     * @see elm_layout_box_remove()
7589     *
7590     * @ingroup Layout
7591     */
7592    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7593    /**
7594     * Insert child to layout table part.
7595     *
7596     * @param obj the layout object
7597     * @param part the box part to pack child.
7598     * @param child_obj the child object to pack into table.
7599     * @param col the column to which the child should be added. (>= 0)
7600     * @param row the row to which the child should be added. (>= 0)
7601     * @param colspan how many columns should be used to store this object. (>=
7602     *        1)
7603     * @param rowspan how many rows should be used to store this object. (>= 1)
7604     *
7605     * Once the object is inserted, it will become child of the table. Its
7606     * lifetime will be bound to the layout, and whenever the layout dies the
7607     * child will be deleted automatically. One should use
7608     * elm_layout_table_remove() to make this layout forget about the object.
7609     *
7610     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7611     * more space than a single cell. For instance, the following code:
7612     * @code
7613     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7614     * @endcode
7615     *
7616     * Would result in an object being added like the following picture:
7617     *
7618     * @image html layout_colspan.png
7619     * @image latex layout_colspan.eps width=\textwidth
7620     *
7621     * @see elm_layout_table_unpack()
7622     * @see elm_layout_table_clear()
7623     *
7624     * @ingroup Layout
7625     */
7626    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);
7627    /**
7628     * Unpack (remove) a child of the given part table.
7629     *
7630     * @param obj The layout object
7631     * @param part The table part name to remove child.
7632     * @param child_obj The object to remove from table.
7633     * @return The object that was being used, or NULL if not found.
7634     *
7635     * The object will be unpacked from the table part and its lifetime
7636     * will not be handled by the layout anymore. This is equivalent to
7637     * elm_layout_content_unset() for table.
7638     *
7639     * @see elm_layout_table_pack()
7640     * @see elm_layout_table_clear()
7641     *
7642     * @ingroup Layout
7643     */
7644    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7645    /**
7646     * Remove all child of the given part table.
7647     *
7648     * @param obj The layout object
7649     * @param part The table part name to remove child.
7650     * @param clear If EINA_TRUE, then all objects will be deleted as
7651     *        well, otherwise they will just be removed and will be
7652     *        dangling on the canvas.
7653     *
7654     * The objects will be removed from the table part and their lifetime will
7655     * not be handled by the layout anymore. This is equivalent to
7656     * elm_layout_table_unpack() for all table children.
7657     *
7658     * @see elm_layout_table_pack()
7659     * @see elm_layout_table_unpack()
7660     *
7661     * @ingroup Layout
7662     */
7663    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7664    /**
7665     * Get the edje layout
7666     *
7667     * @param obj The layout object
7668     *
7669     * @return A Evas_Object with the edje layout settings loaded
7670     * with function elm_layout_file_set
7671     *
7672     * This returns the edje object. It is not expected to be used to then
7673     * swallow objects via edje_object_part_swallow() for example. Use
7674     * elm_layout_content_set() instead so child object handling and sizing is
7675     * done properly.
7676     *
7677     * @note This function should only be used if you really need to call some
7678     * low level Edje function on this edje object. All the common stuff (setting
7679     * text, emitting signals, hooking callbacks to signals, etc.) can be done
7680     * with proper elementary functions.
7681     *
7682     * @see elm_object_signal_callback_add()
7683     * @see elm_object_signal_emit()
7684     * @see elm_object_text_part_set()
7685     * @see elm_layout_content_set()
7686     * @see elm_layout_box_append()
7687     * @see elm_layout_table_pack()
7688     * @see elm_layout_data_get()
7689     *
7690     * @ingroup Layout
7691     */
7692    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7693    /**
7694     * Get the edje data from the given layout
7695     *
7696     * @param obj The layout object
7697     * @param key The data key
7698     *
7699     * @return The edje data string
7700     *
7701     * This function fetches data specified inside the edje theme of this layout.
7702     * This function return NULL if data is not found.
7703     *
7704     * In EDC this comes from a data block within the group block that @p
7705     * obj was loaded from. E.g.
7706     *
7707     * @code
7708     * collections {
7709     *   group {
7710     *     name: "a_group";
7711     *     data {
7712     *       item: "key1" "value1";
7713     *       item: "key2" "value2";
7714     *     }
7715     *   }
7716     * }
7717     * @endcode
7718     *
7719     * @ingroup Layout
7720     */
7721    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7722    /**
7723     * Eval sizing
7724     *
7725     * @param obj The layout object
7726     *
7727     * Manually forces a sizing re-evaluation. This is useful when the minimum
7728     * size required by the edje theme of this layout has changed. The change on
7729     * the minimum size required by the edje theme is not immediately reported to
7730     * the elementary layout, so one needs to call this function in order to tell
7731     * the widget (layout) that it needs to reevaluate its own size.
7732     *
7733     * The minimum size of the theme is calculated based on minimum size of
7734     * parts, the size of elements inside containers like box and table, etc. All
7735     * of this can change due to state changes, and that's when this function
7736     * should be called.
7737     *
7738     * Also note that a standard signal of "size,eval" "elm" emitted from the
7739     * edje object will cause this to happen too.
7740     *
7741     * @ingroup Layout
7742     */
7743    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7744    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7745    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7746    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7747    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7748    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7749    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);
7750    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7751 /**
7752  * @def elm_layout_icon_set
7753  * Convienience macro to set the icon object in a layout that follows the
7754  * Elementary naming convention for its parts.
7755  *
7756  * @ingroup Layout
7757  */
7758 #define elm_layout_icon_set(_ly, _obj) \
7759   do { \
7760     const char *sig; \
7761     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7762     if ((_obj)) sig = "elm,state,icon,visible"; \
7763     else sig = "elm,state,icon,hidden"; \
7764     elm_object_signal_emit((_ly), sig, "elm"); \
7765   } while (0)
7766
7767 /**
7768  * @def elm_layout_icon_get
7769  * Convienience macro to get the icon object from a layout that follows the
7770  * Elementary naming convention for its parts.
7771  *
7772  * @ingroup Layout
7773  */
7774 #define elm_layout_icon_get(_ly) \
7775   elm_layout_content_get((_ly), "elm.swallow.icon")
7776
7777 /**
7778  * @def elm_layout_end_set
7779  * Convienience macro to set the end object in a layout that follows the
7780  * Elementary naming convention for its parts.
7781  *
7782  * @ingroup Layout
7783  */
7784 #define elm_layout_end_set(_ly, _obj) \
7785   do { \
7786     const char *sig; \
7787     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7788     if ((_obj)) sig = "elm,state,end,visible"; \
7789     else sig = "elm,state,end,hidden"; \
7790     elm_object_signal_emit((_ly), sig, "elm"); \
7791   } while (0)
7792
7793 /**
7794  * @def elm_layout_end_get
7795  * Convienience macro to get the end object in a layout that follows the
7796  * Elementary naming convention for its parts.
7797  *
7798  * @ingroup Layout
7799  */
7800 #define elm_layout_end_get(_ly) \
7801   elm_layout_content_get((_ly), "elm.swallow.end")
7802
7803 /**
7804  * @def elm_layout_label_set
7805  * Convienience macro to set the label in a layout that follows the
7806  * Elementary naming convention for its parts.
7807  *
7808  * @ingroup Layout
7809  * @deprecated use elm_object_text_* instead.
7810  */
7811 #define elm_layout_label_set(_ly, _txt) \
7812   elm_layout_text_set((_ly), "elm.text", (_txt))
7813
7814 /**
7815  * @def elm_layout_label_get
7816  * Convienience macro to get the label in a layout that follows the
7817  * Elementary naming convention for its parts.
7818  *
7819  * @ingroup Layout
7820  * @deprecated use elm_object_text_* instead.
7821  */
7822 #define elm_layout_label_get(_ly) \
7823   elm_layout_text_get((_ly), "elm.text")
7824
7825    /* smart callbacks called:
7826     * "theme,changed" - when elm theme is changed.
7827     */
7828
7829    /**
7830     * @defgroup Notify Notify
7831     *
7832     * @image html img/widget/notify/preview-00.png
7833     * @image latex img/widget/notify/preview-00.eps
7834     *
7835     * Display a container in a particular region of the parent(top, bottom,
7836     * etc.  A timeout can be set to automatically hide the notify. This is so
7837     * that, after an evas_object_show() on a notify object, if a timeout was set
7838     * on it, it will @b automatically get hidden after that time.
7839     *
7840     * Signals that you can add callbacks for are:
7841     * @li "timeout" - when timeout happens on notify and it's hidden
7842     * @li "block,clicked" - when a click outside of the notify happens
7843     *
7844     * @ref tutorial_notify show usage of the API.
7845     *
7846     * @{
7847     */
7848    /**
7849     * @brief Possible orient values for notify.
7850     *
7851     * This values should be used in conjunction to elm_notify_orient_set() to
7852     * set the position in which the notify should appear(relative to its parent)
7853     * and in conjunction with elm_notify_orient_get() to know where the notify
7854     * is appearing.
7855     */
7856    typedef enum _Elm_Notify_Orient
7857      {
7858         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
7859         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
7860         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
7861         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
7862         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
7863         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
7864         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
7865         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
7866         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
7867         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
7868      } Elm_Notify_Orient;
7869    /**
7870     * @brief Add a new notify to the parent
7871     *
7872     * @param parent The parent object
7873     * @return The new object or NULL if it cannot be created
7874     */
7875    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7876    /**
7877     * @brief Set the content of the notify widget
7878     *
7879     * @param obj The notify object
7880     * @param content The content will be filled in this notify object
7881     *
7882     * Once the content object is set, a previously set one will be deleted. If
7883     * you want to keep that old content object, use the
7884     * elm_notify_content_unset() function.
7885     */
7886    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7887    /**
7888     * @brief Unset the content of the notify widget
7889     *
7890     * @param obj The notify object
7891     * @return The content that was being used
7892     *
7893     * Unparent and return the content object which was set for this widget
7894     *
7895     * @see elm_notify_content_set()
7896     */
7897    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7898    /**
7899     * @brief Return the content of the notify widget
7900     *
7901     * @param obj The notify object
7902     * @return The content that is being used
7903     *
7904     * @see elm_notify_content_set()
7905     */
7906    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7907    /**
7908     * @brief Set the notify parent
7909     *
7910     * @param obj The notify object
7911     * @param content The new parent
7912     *
7913     * Once the parent object is set, a previously set one will be disconnected
7914     * and replaced.
7915     */
7916    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7917    /**
7918     * @brief Get the notify parent
7919     *
7920     * @param obj The notify object
7921     * @return The parent
7922     *
7923     * @see elm_notify_parent_set()
7924     */
7925    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7926    /**
7927     * @brief Set the orientation
7928     *
7929     * @param obj The notify object
7930     * @param orient The new orientation
7931     *
7932     * Sets the position in which the notify will appear in its parent.
7933     *
7934     * @see @ref Elm_Notify_Orient for possible values.
7935     */
7936    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
7937    /**
7938     * @brief Return the orientation
7939     * @param obj The notify object
7940     * @return The orientation of the notification
7941     *
7942     * @see elm_notify_orient_set()
7943     * @see Elm_Notify_Orient
7944     */
7945    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7946    /**
7947     * @brief Set the time interval after which the notify window is going to be
7948     * hidden.
7949     *
7950     * @param obj The notify object
7951     * @param time The timeout in seconds
7952     *
7953     * This function sets a timeout and starts the timer controlling when the
7954     * notify is hidden. Since calling evas_object_show() on a notify restarts
7955     * the timer controlling when the notify is hidden, setting this before the
7956     * notify is shown will in effect mean starting the timer when the notify is
7957     * shown.
7958     *
7959     * @note Set a value <= 0.0 to disable a running timer.
7960     *
7961     * @note If the value > 0.0 and the notify is previously visible, the
7962     * timer will be started with this value, canceling any running timer.
7963     */
7964    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7965    /**
7966     * @brief Return the timeout value (in seconds)
7967     * @param obj the notify object
7968     *
7969     * @see elm_notify_timeout_set()
7970     */
7971    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7972    /**
7973     * @brief Sets whether events should be passed to by a click outside
7974     * its area.
7975     *
7976     * @param obj The notify object
7977     * @param repeats EINA_TRUE Events are repeats, else no
7978     *
7979     * When true if the user clicks outside the window the events will be caught
7980     * by the others widgets, else the events are blocked.
7981     *
7982     * @note The default value is EINA_TRUE.
7983     */
7984    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
7985    /**
7986     * @brief Return true if events are repeat below the notify object
7987     * @param obj the notify object
7988     *
7989     * @see elm_notify_repeat_events_set()
7990     */
7991    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7992    /**
7993     * @}
7994     */
7995
7996    /**
7997     * @defgroup Hover Hover
7998     *
7999     * @image html img/widget/hover/preview-00.png
8000     * @image latex img/widget/hover/preview-00.eps
8001     *
8002     * A Hover object will hover over its @p parent object at the @p target
8003     * location. Anything in the background will be given a darker coloring to
8004     * indicate that the hover object is on top (at the default theme). When the
8005     * hover is clicked it is dismissed(hidden), if the contents of the hover are
8006     * clicked that @b doesn't cause the hover to be dismissed.
8007     *
8008     * @note The hover object will take up the entire space of @p target
8009     * object.
8010     *
8011     * Elementary has the following styles for the hover widget:
8012     * @li default
8013     * @li popout
8014     * @li menu
8015     * @li hoversel_vertical
8016     *
8017     * The following are the available position for content:
8018     * @li left
8019     * @li top-left
8020     * @li top
8021     * @li top-right
8022     * @li right
8023     * @li bottom-right
8024     * @li bottom
8025     * @li bottom-left
8026     * @li middle
8027     * @li smart
8028     *
8029     * Signals that you can add callbacks for are:
8030     * @li "clicked" - the user clicked the empty space in the hover to dismiss
8031     * @li "smart,changed" - a content object placed under the "smart"
8032     *                   policy was replaced to a new slot direction.
8033     *
8034     * See @ref tutorial_hover for more information.
8035     *
8036     * @{
8037     */
8038    typedef enum _Elm_Hover_Axis
8039      {
8040         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8041         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8042         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8043         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8044      } Elm_Hover_Axis;
8045    /**
8046     * @brief Adds a hover object to @p parent
8047     *
8048     * @param parent The parent object
8049     * @return The hover object or NULL if one could not be created
8050     */
8051    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8052    /**
8053     * @brief Sets the target object for the hover.
8054     *
8055     * @param obj The hover object
8056     * @param target The object to center the hover onto. The hover
8057     *
8058     * This function will cause the hover to be centered on the target object.
8059     */
8060    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8061    /**
8062     * @brief Gets the target object for the hover.
8063     *
8064     * @param obj The hover object
8065     * @param parent The object to locate the hover over.
8066     *
8067     * @see elm_hover_target_set()
8068     */
8069    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8070    /**
8071     * @brief Sets the parent object for the hover.
8072     *
8073     * @param obj The hover object
8074     * @param parent The object to locate the hover over.
8075     *
8076     * This function will cause the hover to take up the entire space that the
8077     * parent object fills.
8078     */
8079    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8080    /**
8081     * @brief Gets the parent object for the hover.
8082     *
8083     * @param obj The hover object
8084     * @return The parent object to locate the hover over.
8085     *
8086     * @see elm_hover_parent_set()
8087     */
8088    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8089    /**
8090     * @brief Sets the content of the hover object and the direction in which it
8091     * will pop out.
8092     *
8093     * @param obj The hover object
8094     * @param swallow The direction that the object will be displayed
8095     * at. Accepted values are "left", "top-left", "top", "top-right",
8096     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8097     * "smart".
8098     * @param content The content to place at @p swallow
8099     *
8100     * Once the content object is set for a given direction, a previously
8101     * set one (on the same direction) will be deleted. If you want to
8102     * keep that old content object, use the elm_hover_content_unset()
8103     * function.
8104     *
8105     * All directions may have contents at the same time, except for
8106     * "smart". This is a special placement hint and its use case
8107     * independs of the calculations coming from
8108     * elm_hover_best_content_location_get(). Its use is for cases when
8109     * one desires only one hover content, but with a dinamic special
8110     * placement within the hover area. The content's geometry, whenever
8111     * it changes, will be used to decide on a best location not
8112     * extrapolating the hover's parent object view to show it in (still
8113     * being the hover's target determinant of its medium part -- move and
8114     * resize it to simulate finger sizes, for example). If one of the
8115     * directions other than "smart" are used, a previously content set
8116     * using it will be deleted, and vice-versa.
8117     */
8118    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8119    /**
8120     * @brief Get the content of the hover object, in a given direction.
8121     *
8122     * Return the content object which was set for this widget in the
8123     * @p swallow direction.
8124     *
8125     * @param obj The hover object
8126     * @param swallow The direction that the object was display at.
8127     * @return The content that was being used
8128     *
8129     * @see elm_hover_content_set()
8130     */
8131    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8132    /**
8133     * @brief Unset the content of the hover object, in a given direction.
8134     *
8135     * Unparent and return the content object set at @p swallow direction.
8136     *
8137     * @param obj The hover object
8138     * @param swallow The direction that the object was display at.
8139     * @return The content that was being used.
8140     *
8141     * @see elm_hover_content_set()
8142     */
8143    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8144    /**
8145     * @brief Returns the best swallow location for content in the hover.
8146     *
8147     * @param obj The hover object
8148     * @param pref_axis The preferred orientation axis for the hover object to use
8149     * @return The edje location to place content into the hover or @c
8150     *         NULL, on errors.
8151     *
8152     * Best is defined here as the location at which there is the most available
8153     * space.
8154     *
8155     * @p pref_axis may be one of
8156     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8157     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8158     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8159     * - @c ELM_HOVER_AXIS_BOTH -- both
8160     *
8161     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8162     * nescessarily be along the horizontal axis("left" or "right"). If
8163     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8164     * be along the vertical axis("top" or "bottom"). Chossing
8165     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8166     * returned position may be in either axis.
8167     *
8168     * @see elm_hover_content_set()
8169     */
8170    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8171    /**
8172     * @}
8173     */
8174
8175    /* entry */
8176    /**
8177     * @defgroup Entry Entry
8178     *
8179     * @image html img/widget/entry/preview-00.png
8180     * @image latex img/widget/entry/preview-00.eps width=\textwidth
8181     * @image html img/widget/entry/preview-01.png
8182     * @image latex img/widget/entry/preview-01.eps width=\textwidth
8183     * @image html img/widget/entry/preview-02.png
8184     * @image latex img/widget/entry/preview-02.eps width=\textwidth
8185     * @image html img/widget/entry/preview-03.png
8186     * @image latex img/widget/entry/preview-03.eps width=\textwidth
8187     *
8188     * An entry is a convenience widget which shows a box that the user can
8189     * enter text into. Entries by default don't scroll, so they grow to
8190     * accomodate the entire text, resizing the parent window as needed. This
8191     * can be changed with the elm_entry_scrollable_set() function.
8192     *
8193     * They can also be single line or multi line (the default) and when set
8194     * to multi line mode they support text wrapping in any of the modes
8195     * indicated by #Elm_Wrap_Type.
8196     *
8197     * Other features include password mode, filtering of inserted text with
8198     * elm_entry_text_filter_append() and related functions, inline "items" and
8199     * formatted markup text.
8200     *
8201     * @section entry-markup Formatted text
8202     *
8203     * The markup tags supported by the Entry are defined by the theme, but
8204     * even when writing new themes or extensions it's a good idea to stick to
8205     * a sane default, to maintain coherency and avoid application breakages.
8206     * Currently defined by the default theme are the following tags:
8207     * @li \<br\>: Inserts a line break.
8208     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8209     * breaks.
8210     * @li \<tab\>: Inserts a tab.
8211     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8212     * enclosed text.
8213     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8214     * @li \<link\>...\</link\>: Underlines the enclosed text.
8215     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8216     *
8217     * @section entry-special Special markups
8218     *
8219     * Besides those used to format text, entries support two special markup
8220     * tags used to insert clickable portions of text or items inlined within
8221     * the text.
8222     *
8223     * @subsection entry-anchors Anchors
8224     *
8225     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8226     * \</a\> tags and an event will be generated when this text is clicked,
8227     * like this:
8228     *
8229     * @code
8230     * This text is outside <a href=anc-01>but this one is an anchor</a>
8231     * @endcode
8232     *
8233     * The @c href attribute in the opening tag gives the name that will be
8234     * used to identify the anchor and it can be any valid utf8 string.
8235     *
8236     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8237     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8238     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8239     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8240     * an anchor.
8241     *
8242     * @subsection entry-items Items
8243     *
8244     * Inlined in the text, any other @c Evas_Object can be inserted by using
8245     * \<item\> tags this way:
8246     *
8247     * @code
8248     * <item size=16x16 vsize=full href=emoticon/haha></item>
8249     * @endcode
8250     *
8251     * Just like with anchors, the @c href identifies each item, but these need,
8252     * in addition, to indicate their size, which is done using any one of
8253     * @c size, @c absize or @c relsize attributes. These attributes take their
8254     * value in the WxH format, where W is the width and H the height of the
8255     * item.
8256     *
8257     * @li absize: Absolute pixel size for the item. Whatever value is set will
8258     * be the item's size regardless of any scale value the object may have
8259     * been set to. The final line height will be adjusted to fit larger items.
8260     * @li size: Similar to @c absize, but it's adjusted to the scale value set
8261     * for the object.
8262     * @li relsize: Size is adjusted for the item to fit within the current
8263     * line height.
8264     *
8265     * Besides their size, items are specificed a @c vsize value that affects
8266     * how their final size and position are calculated. The possible values
8267     * are:
8268     * @li ascent: Item will be placed within the line's baseline and its
8269     * ascent. That is, the height between the line where all characters are
8270     * positioned and the highest point in the line. For @c size and @c absize
8271     * items, the descent value will be added to the total line height to make
8272     * them fit. @c relsize items will be adjusted to fit within this space.
8273     * @li full: Items will be placed between the descent and ascent, or the
8274     * lowest point in the line and its highest.
8275     *
8276     * The next image shows different configurations of items and how they
8277     * are the previously mentioned options affect their sizes. In all cases,
8278     * the green line indicates the ascent, blue for the baseline and red for
8279     * the descent.
8280     *
8281     * @image html entry_item.png
8282     * @image latex entry_item.eps width=\textwidth
8283     *
8284     * And another one to show how size differs from absize. In the first one,
8285     * the scale value is set to 1.0, while the second one is using one of 2.0.
8286     *
8287     * @image html entry_item_scale.png
8288     * @image latex entry_item_scale.eps width=\textwidth
8289     *
8290     * After the size for an item is calculated, the entry will request an
8291     * object to place in its space. For this, the functions set with
8292     * elm_entry_item_provider_append() and related functions will be called
8293     * in order until one of them returns a @c non-NULL value. If no providers
8294     * are available, or all of them return @c NULL, then the entry falls back
8295     * to one of the internal defaults, provided the name matches with one of
8296     * them.
8297     *
8298     * All of the following are currently supported:
8299     *
8300     * - emoticon/angry
8301     * - emoticon/angry-shout
8302     * - emoticon/crazy-laugh
8303     * - emoticon/evil-laugh
8304     * - emoticon/evil
8305     * - emoticon/goggle-smile
8306     * - emoticon/grumpy
8307     * - emoticon/grumpy-smile
8308     * - emoticon/guilty
8309     * - emoticon/guilty-smile
8310     * - emoticon/haha
8311     * - emoticon/half-smile
8312     * - emoticon/happy-panting
8313     * - emoticon/happy
8314     * - emoticon/indifferent
8315     * - emoticon/kiss
8316     * - emoticon/knowing-grin
8317     * - emoticon/laugh
8318     * - emoticon/little-bit-sorry
8319     * - emoticon/love-lots
8320     * - emoticon/love
8321     * - emoticon/minimal-smile
8322     * - emoticon/not-happy
8323     * - emoticon/not-impressed
8324     * - emoticon/omg
8325     * - emoticon/opensmile
8326     * - emoticon/smile
8327     * - emoticon/sorry
8328     * - emoticon/squint-laugh
8329     * - emoticon/surprised
8330     * - emoticon/suspicious
8331     * - emoticon/tongue-dangling
8332     * - emoticon/tongue-poke
8333     * - emoticon/uh
8334     * - emoticon/unhappy
8335     * - emoticon/very-sorry
8336     * - emoticon/what
8337     * - emoticon/wink
8338     * - emoticon/worried
8339     * - emoticon/wtf
8340     *
8341     * Alternatively, an item may reference an image by its path, using
8342     * the URI form @c file:///path/to/an/image.png and the entry will then
8343     * use that image for the item.
8344     *
8345     * @section entry-files Loading and saving files
8346     *
8347     * Entries have convinience functions to load text from a file and save
8348     * changes back to it after a short delay. The automatic saving is enabled
8349     * by default, but can be disabled with elm_entry_autosave_set() and files
8350     * can be loaded directly as plain text or have any markup in them
8351     * recognized. See elm_entry_file_set() for more details.
8352     *
8353     * @section entry-signals Emitted signals
8354     *
8355     * This widget emits the following signals:
8356     *
8357     * @li "changed": The text within the entry was changed.
8358     * @li "changed,user": The text within the entry was changed because of user interaction.
8359     * @li "activated": The enter key was pressed on a single line entry.
8360     * @li "press": A mouse button has been pressed on the entry.
8361     * @li "longpressed": A mouse button has been pressed and held for a couple
8362     * seconds.
8363     * @li "clicked": The entry has been clicked (mouse press and release).
8364     * @li "clicked,double": The entry has been double clicked.
8365     * @li "clicked,triple": The entry has been triple clicked.
8366     * @li "focused": The entry has received focus.
8367     * @li "unfocused": The entry has lost focus.
8368     * @li "selection,paste": A paste of the clipboard contents was requested.
8369     * @li "selection,copy": A copy of the selected text into the clipboard was
8370     * requested.
8371     * @li "selection,cut": A cut of the selected text into the clipboard was
8372     * requested.
8373     * @li "selection,start": A selection has begun and no previous selection
8374     * existed.
8375     * @li "selection,changed": The current selection has changed.
8376     * @li "selection,cleared": The current selection has been cleared.
8377     * @li "cursor,changed": The cursor has changed position.
8378     * @li "anchor,clicked": An anchor has been clicked. The event_info
8379     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8380     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8381     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8382     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8383     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8384     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8385     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8386     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8387     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8388     * @li "preedit,changed": The preedit string has changed.
8389     *
8390     * @section entry-examples
8391     *
8392     * An overview of the Entry API can be seen in @ref entry_example_01
8393     *
8394     * @{
8395     */
8396    /**
8397     * @typedef Elm_Entry_Anchor_Info
8398     *
8399     * The info sent in the callback for the "anchor,clicked" signals emitted
8400     * by entries.
8401     */
8402    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8403    /**
8404     * @struct _Elm_Entry_Anchor_Info
8405     *
8406     * The info sent in the callback for the "anchor,clicked" signals emitted
8407     * by entries.
8408     */
8409    struct _Elm_Entry_Anchor_Info
8410      {
8411         const char *name; /**< The name of the anchor, as stated in its href */
8412         int         button; /**< The mouse button used to click on it */
8413         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
8414                     y, /**< Anchor geometry, relative to canvas */
8415                     w, /**< Anchor geometry, relative to canvas */
8416                     h; /**< Anchor geometry, relative to canvas */
8417      };
8418    /**
8419     * @typedef Elm_Entry_Filter_Cb
8420     * This callback type is used by entry filters to modify text.
8421     * @param data The data specified as the last param when adding the filter
8422     * @param entry The entry object
8423     * @param text A pointer to the location of the text being filtered. This data can be modified,
8424     * but any additional allocations must be managed by the user.
8425     * @see elm_entry_text_filter_append
8426     * @see elm_entry_text_filter_prepend
8427     */
8428    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8429
8430    /**
8431     * This adds an entry to @p parent object.
8432     *
8433     * By default, entries are:
8434     * @li not scrolled
8435     * @li multi-line
8436     * @li word wrapped
8437     * @li autosave is enabled
8438     *
8439     * @param parent The parent object
8440     * @return The new object or NULL if it cannot be created
8441     */
8442    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8443    /**
8444     * Sets the entry to single line mode.
8445     *
8446     * In single line mode, entries don't ever wrap when the text reaches the
8447     * edge, and instead they keep growing horizontally. Pressing the @c Enter
8448     * key will generate an @c "activate" event instead of adding a new line.
8449     *
8450     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8451     * and pressing enter will break the text into a different line
8452     * without generating any events.
8453     *
8454     * @param obj The entry object
8455     * @param single_line If true, the text in the entry
8456     * will be on a single line.
8457     */
8458    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8459    /**
8460     * Gets whether the entry is set to be single line.
8461     *
8462     * @param obj The entry object
8463     * @return single_line If true, the text in the entry is set to display
8464     * on a single line.
8465     *
8466     * @see elm_entry_single_line_set()
8467     */
8468    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8469    /**
8470     * Sets the entry to password mode.
8471     *
8472     * In password mode, entries are implicitly single line and the display of
8473     * any text in them is replaced with asterisks (*).
8474     *
8475     * @param obj The entry object
8476     * @param password If true, password mode is enabled.
8477     */
8478    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8479    /**
8480     * Gets whether the entry is set to password mode.
8481     *
8482     * @param obj The entry object
8483     * @return If true, the entry is set to display all characters
8484     * as asterisks (*).
8485     *
8486     * @see elm_entry_password_set()
8487     */
8488    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8489    /**
8490     * This sets the text displayed within the entry to @p entry.
8491     *
8492     * @param obj The entry object
8493     * @param entry The text to be displayed
8494     *
8495     * @deprecated Use elm_object_text_set() instead.
8496     */
8497    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8498    /**
8499     * This returns the text currently shown in object @p entry.
8500     * See also elm_entry_entry_set().
8501     *
8502     * @param obj The entry object
8503     * @return The currently displayed text or NULL on failure
8504     *
8505     * @deprecated Use elm_object_text_get() instead.
8506     */
8507    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8508    /**
8509     * Appends @p entry to the text of the entry.
8510     *
8511     * Adds the text in @p entry to the end of any text already present in the
8512     * widget.
8513     *
8514     * The appended text is subject to any filters set for the widget.
8515     *
8516     * @param obj The entry object
8517     * @param entry The text to be displayed
8518     *
8519     * @see elm_entry_text_filter_append()
8520     */
8521    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8522    /**
8523     * Gets whether the entry is empty.
8524     *
8525     * Empty means no text at all. If there are any markup tags, like an item
8526     * tag for which no provider finds anything, and no text is displayed, this
8527     * function still returns EINA_FALSE.
8528     *
8529     * @param obj The entry object
8530     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8531     */
8532    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8533    /**
8534     * Gets any selected text within the entry.
8535     *
8536     * If there's any selected text in the entry, this function returns it as
8537     * a string in markup format. NULL is returned if no selection exists or
8538     * if an error occurred.
8539     *
8540     * The returned value points to an internal string and should not be freed
8541     * or modified in any way. If the @p entry object is deleted or its
8542     * contents are changed, the returned pointer should be considered invalid.
8543     *
8544     * @param obj The entry object
8545     * @return The selected text within the entry or NULL on failure
8546     */
8547    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8548    /**
8549     * Inserts the given text into the entry at the current cursor position.
8550     *
8551     * This inserts text at the cursor position as if it was typed
8552     * by the user (note that this also allows markup which a user
8553     * can't just "type" as it would be converted to escaped text, so this
8554     * call can be used to insert things like emoticon items or bold push/pop
8555     * tags, other font and color change tags etc.)
8556     *
8557     * If any selection exists, it will be replaced by the inserted text.
8558     *
8559     * The inserted text is subject to any filters set for the widget.
8560     *
8561     * @param obj The entry object
8562     * @param entry The text to insert
8563     *
8564     * @see elm_entry_text_filter_append()
8565     */
8566    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8567    /**
8568     * Set the line wrap type to use on multi-line entries.
8569     *
8570     * Sets the wrap type used by the entry to any of the specified in
8571     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8572     * line (without inserting a line break or paragraph separator) when it
8573     * reaches the far edge of the widget.
8574     *
8575     * Note that this only makes sense for multi-line entries. A widget set
8576     * to be single line will never wrap.
8577     *
8578     * @param obj The entry object
8579     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8580     */
8581    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8582    /**
8583     * Gets the wrap mode the entry was set to use.
8584     *
8585     * @param obj The entry object
8586     * @return Wrap type
8587     *
8588     * @see also elm_entry_line_wrap_set()
8589     */
8590    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8591    /**
8592     * Sets if the entry is to be editable or not.
8593     *
8594     * By default, entries are editable and when focused, any text input by the
8595     * user will be inserted at the current cursor position. But calling this
8596     * function with @p editable as EINA_FALSE will prevent the user from
8597     * inputting text into the entry.
8598     *
8599     * The only way to change the text of a non-editable entry is to use
8600     * elm_object_text_set(), elm_entry_entry_insert() and other related
8601     * functions.
8602     *
8603     * @param obj The entry object
8604     * @param editable If EINA_TRUE, user input will be inserted in the entry,
8605     * if not, the entry is read-only and no user input is allowed.
8606     */
8607    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8608    /**
8609     * Gets whether the entry is editable or not.
8610     *
8611     * @param obj The entry object
8612     * @return If true, the entry is editable by the user.
8613     * If false, it is not editable by the user
8614     *
8615     * @see elm_entry_editable_set()
8616     */
8617    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8618    /**
8619     * This drops any existing text selection within the entry.
8620     *
8621     * @param obj The entry object
8622     */
8623    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8624    /**
8625     * This selects all text within the entry.
8626     *
8627     * @param obj The entry object
8628     */
8629    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8630    /**
8631     * This moves the cursor one place to the right within the entry.
8632     *
8633     * @param obj The entry object
8634     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8635     */
8636    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8637    /**
8638     * This moves the cursor one place to the left within the entry.
8639     *
8640     * @param obj The entry object
8641     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8642     */
8643    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8644    /**
8645     * This moves the cursor one line up within the entry.
8646     *
8647     * @param obj The entry object
8648     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8649     */
8650    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8651    /**
8652     * This moves the cursor one line down within the entry.
8653     *
8654     * @param obj The entry object
8655     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8656     */
8657    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8658    /**
8659     * This moves the cursor to the beginning of the entry.
8660     *
8661     * @param obj The entry object
8662     */
8663    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8664    /**
8665     * This moves the cursor to the end of the entry.
8666     *
8667     * @param obj The entry object
8668     */
8669    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8670    /**
8671     * This moves the cursor to the beginning of the current line.
8672     *
8673     * @param obj The entry object
8674     */
8675    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8676    /**
8677     * This moves the cursor to the end of the current line.
8678     *
8679     * @param obj The entry object
8680     */
8681    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8682    /**
8683     * This begins a selection within the entry as though
8684     * the user were holding down the mouse button to make a selection.
8685     *
8686     * @param obj The entry object
8687     */
8688    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8689    /**
8690     * This ends a selection within the entry as though
8691     * the user had just released the mouse button while making a selection.
8692     *
8693     * @param obj The entry object
8694     */
8695    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8696    /**
8697     * Gets whether a format node exists at the current cursor position.
8698     *
8699     * A format node is anything that defines how the text is rendered. It can
8700     * be a visible format node, such as a line break or a paragraph separator,
8701     * or an invisible one, such as bold begin or end tag.
8702     * This function returns whether any format node exists at the current
8703     * cursor position.
8704     *
8705     * @param obj The entry object
8706     * @return EINA_TRUE if the current cursor position contains a format node,
8707     * EINA_FALSE otherwise.
8708     *
8709     * @see elm_entry_cursor_is_visible_format_get()
8710     */
8711    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8712    /**
8713     * Gets if the current cursor position holds a visible format node.
8714     *
8715     * @param obj The entry object
8716     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8717     * if it's an invisible one or no format exists.
8718     *
8719     * @see elm_entry_cursor_is_format_get()
8720     */
8721    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8722    /**
8723     * Gets the character pointed by the cursor at its current position.
8724     *
8725     * This function returns a string with the utf8 character stored at the
8726     * current cursor position.
8727     * Only the text is returned, any format that may exist will not be part
8728     * of the return value.
8729     *
8730     * @param obj The entry object
8731     * @return The text pointed by the cursors.
8732     */
8733    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8734    /**
8735     * This function returns the geometry of the cursor.
8736     *
8737     * It's useful if you want to draw something on the cursor (or where it is),
8738     * or for example in the case of scrolled entry where you want to show the
8739     * cursor.
8740     *
8741     * @param obj The entry object
8742     * @param x returned geometry
8743     * @param y returned geometry
8744     * @param w returned geometry
8745     * @param h returned geometry
8746     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8747     */
8748    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);
8749    /**
8750     * Sets the cursor position in the entry to the given value
8751     *
8752     * The value in @p pos is the index of the character position within the
8753     * contents of the string as returned by elm_entry_cursor_pos_get().
8754     *
8755     * @param obj The entry object
8756     * @param pos The position of the cursor
8757     */
8758    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8759    /**
8760     * Retrieves the current position of the cursor in the entry
8761     *
8762     * @param obj The entry object
8763     * @return The cursor position
8764     */
8765    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8766    /**
8767     * This executes a "cut" action on the selected text in the entry.
8768     *
8769     * @param obj The entry object
8770     */
8771    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8772    /**
8773     * This executes a "copy" action on the selected text in the entry.
8774     *
8775     * @param obj The entry object
8776     */
8777    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8778    /**
8779     * This executes a "paste" action in the entry.
8780     *
8781     * @param obj The entry object
8782     */
8783    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8784    /**
8785     * This clears and frees the items in a entry's contextual (longpress)
8786     * menu.
8787     *
8788     * @param obj The entry object
8789     *
8790     * @see elm_entry_context_menu_item_add()
8791     */
8792    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8793    /**
8794     * This adds an item to the entry's contextual menu.
8795     *
8796     * A longpress on an entry will make the contextual menu show up, if this
8797     * hasn't been disabled with elm_entry_context_menu_disabled_set().
8798     * By default, this menu provides a few options like enabling selection mode,
8799     * which is useful on embedded devices that need to be explicit about it,
8800     * and when a selection exists it also shows the copy and cut actions.
8801     *
8802     * With this function, developers can add other options to this menu to
8803     * perform any action they deem necessary.
8804     *
8805     * @param obj The entry object
8806     * @param label The item's text label
8807     * @param icon_file The item's icon file
8808     * @param icon_type The item's icon type
8809     * @param func The callback to execute when the item is clicked
8810     * @param data The data to associate with the item for related functions
8811     */
8812    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);
8813    /**
8814     * This disables the entry's contextual (longpress) menu.
8815     *
8816     * @param obj The entry object
8817     * @param disabled If true, the menu is disabled
8818     */
8819    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8820    /**
8821     * This returns whether the entry's contextual (longpress) menu is
8822     * disabled.
8823     *
8824     * @param obj The entry object
8825     * @return If true, the menu is disabled
8826     */
8827    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8828    /**
8829     * This appends a custom item provider to the list for that entry
8830     *
8831     * This appends the given callback. The list is walked from beginning to end
8832     * with each function called given the item href string in the text. If the
8833     * function returns an object handle other than NULL (it should create an
8834     * object to do this), then this object is used to replace that item. If
8835     * not the next provider is called until one provides an item object, or the
8836     * default provider in entry does.
8837     *
8838     * @param obj The entry object
8839     * @param func The function called to provide the item object
8840     * @param data The data passed to @p func
8841     *
8842     * @see @ref entry-items
8843     */
8844    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);
8845    /**
8846     * This prepends a custom item provider to the list for that entry
8847     *
8848     * This prepends the given callback. See elm_entry_item_provider_append() for
8849     * more information
8850     *
8851     * @param obj The entry object
8852     * @param func The function called to provide the item object
8853     * @param data The data passed to @p func
8854     */
8855    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);
8856    /**
8857     * This removes a custom item provider to the list for that entry
8858     *
8859     * This removes the given callback. See elm_entry_item_provider_append() for
8860     * more information
8861     *
8862     * @param obj The entry object
8863     * @param func The function called to provide the item object
8864     * @param data The data passed to @p func
8865     */
8866    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);
8867    /**
8868     * Append a filter function for text inserted in the entry
8869     *
8870     * Append the given callback to the list. This functions will be called
8871     * whenever any text is inserted into the entry, with the text to be inserted
8872     * as a parameter. The callback function is free to alter the text in any way
8873     * it wants, but it must remember to free the given pointer and update it.
8874     * If the new text is to be discarded, the function can free it and set its
8875     * text parameter to NULL. This will also prevent any following filters from
8876     * being called.
8877     *
8878     * @param obj The entry object
8879     * @param func The function to use as text filter
8880     * @param data User data to pass to @p func
8881     */
8882    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8883    /**
8884     * Prepend a filter function for text insdrted in the entry
8885     *
8886     * Prepend the given callback to the list. See elm_entry_text_filter_append()
8887     * for more information
8888     *
8889     * @param obj The entry object
8890     * @param func The function to use as text filter
8891     * @param data User data to pass to @p func
8892     */
8893    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8894    /**
8895     * Remove a filter from the list
8896     *
8897     * Removes the given callback from the filter list. See
8898     * elm_entry_text_filter_append() for more information.
8899     *
8900     * @param obj The entry object
8901     * @param func The filter function to remove
8902     * @param data The user data passed when adding the function
8903     */
8904    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8905    /**
8906     * This converts a markup (HTML-like) string into UTF-8.
8907     *
8908     * The returned string is a malloc'ed buffer and it should be freed when
8909     * not needed anymore.
8910     *
8911     * @param s The string (in markup) to be converted
8912     * @return The converted string (in UTF-8). It should be freed.
8913     */
8914    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8915    /**
8916     * This converts a UTF-8 string into markup (HTML-like).
8917     *
8918     * The returned string is a malloc'ed buffer and it should be freed when
8919     * not needed anymore.
8920     *
8921     * @param s The string (in UTF-8) to be converted
8922     * @return The converted string (in markup). It should be freed.
8923     */
8924    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8925    /**
8926     * This sets the file (and implicitly loads it) for the text to display and
8927     * then edit. All changes are written back to the file after a short delay if
8928     * the entry object is set to autosave (which is the default).
8929     *
8930     * If the entry had any other file set previously, any changes made to it
8931     * will be saved if the autosave feature is enabled, otherwise, the file
8932     * will be silently discarded and any non-saved changes will be lost.
8933     *
8934     * @param obj The entry object
8935     * @param file The path to the file to load and save
8936     * @param format The file format
8937     */
8938    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8939    /**
8940     * Gets the file being edited by the entry.
8941     *
8942     * This function can be used to retrieve any file set on the entry for
8943     * edition, along with the format used to load and save it.
8944     *
8945     * @param obj The entry object
8946     * @param file The path to the file to load and save
8947     * @param format The file format
8948     */
8949    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8950    /**
8951     * This function writes any changes made to the file set with
8952     * elm_entry_file_set()
8953     *
8954     * @param obj The entry object
8955     */
8956    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8957    /**
8958     * This sets the entry object to 'autosave' the loaded text file or not.
8959     *
8960     * @param obj The entry object
8961     * @param autosave Autosave the loaded file or not
8962     *
8963     * @see elm_entry_file_set()
8964     */
8965    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8966    /**
8967     * This gets the entry object's 'autosave' status.
8968     *
8969     * @param obj The entry object
8970     * @return Autosave the loaded file or not
8971     *
8972     * @see elm_entry_file_set()
8973     */
8974    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8975    /**
8976     * Control pasting of text and images for the widget.
8977     *
8978     * Normally the entry allows both text and images to be pasted.  By setting
8979     * textonly to be true, this prevents images from being pasted.
8980     *
8981     * Note this only changes the behaviour of text.
8982     *
8983     * @param obj The entry object
8984     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
8985     * text+image+other.
8986     */
8987    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
8988    /**
8989     * Getting elm_entry text paste/drop mode.
8990     *
8991     * In textonly mode, only text may be pasted or dropped into the widget.
8992     *
8993     * @param obj The entry object
8994     * @return If the widget only accepts text from pastes.
8995     */
8996    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8997    /**
8998     * Enable or disable scrolling in entry
8999     *
9000     * Normally the entry is not scrollable unless you enable it with this call.
9001     *
9002     * @param obj The entry object
9003     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9004     */
9005    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9006    /**
9007     * Get the scrollable state of the entry
9008     *
9009     * Normally the entry is not scrollable. This gets the scrollable state
9010     * of the entry. See elm_entry_scrollable_set() for more information.
9011     *
9012     * @param obj The entry object
9013     * @return The scrollable state
9014     */
9015    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
9016    /**
9017     * This sets a widget to be displayed to the left of a scrolled entry.
9018     *
9019     * @param obj The scrolled entry object
9020     * @param icon The widget to display on the left side of the scrolled
9021     * entry.
9022     *
9023     * @note A previously set widget will be destroyed.
9024     * @note If the object being set does not have minimum size hints set,
9025     * it won't get properly displayed.
9026     *
9027     * @see elm_entry_end_set()
9028     */
9029    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9030    /**
9031     * Gets the leftmost widget of the scrolled entry. This object is
9032     * owned by the scrolled entry and should not be modified.
9033     *
9034     * @param obj The scrolled entry object
9035     * @return the left widget inside the scroller
9036     */
9037    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9038    /**
9039     * Unset the leftmost widget of the scrolled entry, unparenting and
9040     * returning it.
9041     *
9042     * @param obj The scrolled entry object
9043     * @return the previously set icon sub-object of this entry, on
9044     * success.
9045     *
9046     * @see elm_entry_icon_set()
9047     */
9048    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9049    /**
9050     * Sets the visibility of the left-side widget of the scrolled entry,
9051     * set by elm_entry_icon_set().
9052     *
9053     * @param obj The scrolled entry object
9054     * @param setting EINA_TRUE if the object should be displayed,
9055     * EINA_FALSE if not.
9056     */
9057    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9058    /**
9059     * This sets a widget to be displayed to the end of a scrolled entry.
9060     *
9061     * @param obj The scrolled entry object
9062     * @param end The widget to display on the right side of the scrolled
9063     * entry.
9064     *
9065     * @note A previously set widget will be destroyed.
9066     * @note If the object being set does not have minimum size hints set,
9067     * it won't get properly displayed.
9068     *
9069     * @see elm_entry_icon_set
9070     */
9071    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9072    /**
9073     * Gets the endmost widget of the scrolled entry. This object is owned
9074     * by the scrolled entry and should not be modified.
9075     *
9076     * @param obj The scrolled entry object
9077     * @return the right widget inside the scroller
9078     */
9079    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9080    /**
9081     * Unset the endmost widget of the scrolled entry, unparenting and
9082     * returning it.
9083     *
9084     * @param obj The scrolled entry object
9085     * @return the previously set icon sub-object of this entry, on
9086     * success.
9087     *
9088     * @see elm_entry_icon_set()
9089     */
9090    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9091    /**
9092     * Sets the visibility of the end widget of the scrolled entry, set by
9093     * elm_entry_end_set().
9094     *
9095     * @param obj The scrolled entry object
9096     * @param setting EINA_TRUE if the object should be displayed,
9097     * EINA_FALSE if not.
9098     */
9099    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9100    /**
9101     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9102     * them).
9103     *
9104     * Setting an entry to single-line mode with elm_entry_single_line_set()
9105     * will automatically disable the display of scrollbars when the entry
9106     * moves inside its scroller.
9107     *
9108     * @param obj The scrolled entry object
9109     * @param h The horizontal scrollbar policy to apply
9110     * @param v The vertical scrollbar policy to apply
9111     */
9112    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9113    /**
9114     * This enables/disables bouncing within the entry.
9115     *
9116     * This function sets whether the entry will bounce when scrolling reaches
9117     * the end of the contained entry.
9118     *
9119     * @param obj The scrolled entry object
9120     * @param h The horizontal bounce state
9121     * @param v The vertical bounce state
9122     */
9123    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9124    /**
9125     * Get the bounce mode
9126     *
9127     * @param obj The Entry object
9128     * @param h_bounce Allow bounce horizontally
9129     * @param v_bounce Allow bounce vertically
9130     */
9131    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9132
9133    /* pre-made filters for entries */
9134    /**
9135     * @typedef Elm_Entry_Filter_Limit_Size
9136     *
9137     * Data for the elm_entry_filter_limit_size() entry filter.
9138     */
9139    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9140    /**
9141     * @struct _Elm_Entry_Filter_Limit_Size
9142     *
9143     * Data for the elm_entry_filter_limit_size() entry filter.
9144     */
9145    struct _Elm_Entry_Filter_Limit_Size
9146      {
9147         int max_char_count; /**< The maximum number of characters allowed. */
9148         int max_byte_count; /**< The maximum number of bytes allowed*/
9149      };
9150    /**
9151     * Filter inserted text based on user defined character and byte limits
9152     *
9153     * Add this filter to an entry to limit the characters that it will accept
9154     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9155     * The funtion works on the UTF-8 representation of the string, converting
9156     * it from the set markup, thus not accounting for any format in it.
9157     *
9158     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9159     * it as data when setting the filter. In it, it's possible to set limits
9160     * by character count or bytes (any of them is disabled if 0), and both can
9161     * be set at the same time. In that case, it first checks for characters,
9162     * then bytes.
9163     *
9164     * The function will cut the inserted text in order to allow only the first
9165     * number of characters that are still allowed. The cut is made in
9166     * characters, even when limiting by bytes, in order to always contain
9167     * valid ones and avoid half unicode characters making it in.
9168     *
9169     * This filter, like any others, does not apply when setting the entry text
9170     * directly with elm_object_text_set() (or the deprecated
9171     * elm_entry_entry_set()).
9172     */
9173    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9174    /**
9175     * @typedef Elm_Entry_Filter_Accept_Set
9176     *
9177     * Data for the elm_entry_filter_accept_set() entry filter.
9178     */
9179    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9180    /**
9181     * @struct _Elm_Entry_Filter_Accept_Set
9182     *
9183     * Data for the elm_entry_filter_accept_set() entry filter.
9184     */
9185    struct _Elm_Entry_Filter_Accept_Set
9186      {
9187         const char *accepted; /**< Set of characters accepted in the entry. */
9188         const char *rejected; /**< Set of characters rejected from the entry. */
9189      };
9190    /**
9191     * Filter inserted text based on accepted or rejected sets of characters
9192     *
9193     * Add this filter to an entry to restrict the set of accepted characters
9194     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9195     * This structure contains both accepted and rejected sets, but they are
9196     * mutually exclusive.
9197     *
9198     * The @c accepted set takes preference, so if it is set, the filter will
9199     * only work based on the accepted characters, ignoring anything in the
9200     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9201     *
9202     * In both cases, the function filters by matching utf8 characters to the
9203     * raw markup text, so it can be used to remove formatting tags.
9204     *
9205     * This filter, like any others, does not apply when setting the entry text
9206     * directly with elm_object_text_set() (or the deprecated
9207     * elm_entry_entry_set()).
9208     */
9209    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9210    /**
9211     * @}
9212     */
9213
9214    /* composite widgets - these basically put together basic widgets above
9215     * in convenient packages that do more than basic stuff */
9216
9217    /* anchorview */
9218    /**
9219     * @defgroup Anchorview Anchorview
9220     *
9221     * @image html img/widget/anchorview/preview-00.png
9222     * @image latex img/widget/anchorview/preview-00.eps
9223     *
9224     * Anchorview is for displaying text that contains markup with anchors
9225     * like <c>\<a href=1234\>something\</\></c> in it.
9226     *
9227     * Besides being styled differently, the anchorview widget provides the
9228     * necessary functionality so that clicking on these anchors brings up a
9229     * popup with user defined content such as "call", "add to contacts" or
9230     * "open web page". This popup is provided using the @ref Hover widget.
9231     *
9232     * This widget is very similar to @ref Anchorblock, so refer to that
9233     * widget for an example. The only difference Anchorview has is that the
9234     * widget is already provided with scrolling functionality, so if the
9235     * text set to it is too large to fit in the given space, it will scroll,
9236     * whereas the @ref Anchorblock widget will keep growing to ensure all the
9237     * text can be displayed.
9238     *
9239     * This widget emits the following signals:
9240     * @li "anchor,clicked": will be called when an anchor is clicked. The
9241     * @p event_info parameter on the callback will be a pointer of type
9242     * ::Elm_Entry_Anchorview_Info.
9243     *
9244     * See @ref Anchorblock for an example on how to use both of them.
9245     *
9246     * @see Anchorblock
9247     * @see Entry
9248     * @see Hover
9249     *
9250     * @{
9251     */
9252    /**
9253     * @typedef Elm_Entry_Anchorview_Info
9254     *
9255     * The info sent in the callback for "anchor,clicked" signals emitted by
9256     * the Anchorview widget.
9257     */
9258    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9259    /**
9260     * @struct _Elm_Entry_Anchorview_Info
9261     *
9262     * The info sent in the callback for "anchor,clicked" signals emitted by
9263     * the Anchorview widget.
9264     */
9265    struct _Elm_Entry_Anchorview_Info
9266      {
9267         const char     *name; /**< Name of the anchor, as indicated in its href
9268                                    attribute */
9269         int             button; /**< The mouse button used to click on it */
9270         Evas_Object    *hover; /**< The hover object to use for the popup */
9271         struct {
9272              Evas_Coord    x, y, w, h;
9273         } anchor, /**< Geometry selection of text used as anchor */
9274           hover_parent; /**< Geometry of the object used as parent by the
9275                              hover */
9276         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
9277                                              for content on the left side of
9278                                              the hover. Before calling the
9279                                              callback, the widget will make the
9280                                              necessary calculations to check
9281                                              which sides are fit to be set with
9282                                              content, based on the position the
9283                                              hover is activated and its distance
9284                                              to the edges of its parent object
9285                                              */
9286         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
9287                                               the right side of the hover.
9288                                               See @ref hover_left */
9289         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
9290                                             of the hover. See @ref hover_left */
9291         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
9292                                                below the hover. See @ref
9293                                                hover_left */
9294      };
9295    /**
9296     * Add a new Anchorview object
9297     *
9298     * @param parent The parent object
9299     * @return The new object or NULL if it cannot be created
9300     */
9301    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9302    /**
9303     * Set the text to show in the anchorview
9304     *
9305     * Sets the text of the anchorview to @p text. This text can include markup
9306     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9307     * text that will be specially styled and react to click events, ended with
9308     * either of \</a\> or \</\>. When clicked, the anchor will emit an
9309     * "anchor,clicked" signal that you can attach a callback to with
9310     * evas_object_smart_callback_add(). The name of the anchor given in the
9311     * event info struct will be the one set in the href attribute, in this
9312     * case, anchorname.
9313     *
9314     * Other markup can be used to style the text in different ways, but it's
9315     * up to the style defined in the theme which tags do what.
9316     * @deprecated use elm_object_text_set() instead.
9317     */
9318    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9319    /**
9320     * Get the markup text set for the anchorview
9321     *
9322     * Retrieves the text set on the anchorview, with markup tags included.
9323     *
9324     * @param obj The anchorview object
9325     * @return The markup text set or @c NULL if nothing was set or an error
9326     * occurred
9327     * @deprecated use elm_object_text_set() instead.
9328     */
9329    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9330    /**
9331     * Set the parent of the hover popup
9332     *
9333     * Sets the parent object to use by the hover created by the anchorview
9334     * when an anchor is clicked. See @ref Hover for more details on this.
9335     * If no parent is set, the same anchorview object will be used.
9336     *
9337     * @param obj The anchorview object
9338     * @param parent The object to use as parent for the hover
9339     */
9340    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9341    /**
9342     * Get the parent of the hover popup
9343     *
9344     * Get the object used as parent for the hover created by the anchorview
9345     * widget. See @ref Hover for more details on this.
9346     *
9347     * @param obj The anchorview object
9348     * @return The object used as parent for the hover, NULL if none is set.
9349     */
9350    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9351    /**
9352     * Set the style that the hover should use
9353     *
9354     * When creating the popup hover, anchorview will request that it's
9355     * themed according to @p style.
9356     *
9357     * @param obj The anchorview object
9358     * @param style The style to use for the underlying hover
9359     *
9360     * @see elm_object_style_set()
9361     */
9362    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9363    /**
9364     * Get the style that the hover should use
9365     *
9366     * Get the style the hover created by anchorview will use.
9367     *
9368     * @param obj The anchorview object
9369     * @return The style to use by the hover. NULL means the default is used.
9370     *
9371     * @see elm_object_style_set()
9372     */
9373    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9374    /**
9375     * Ends the hover popup in the anchorview
9376     *
9377     * When an anchor is clicked, the anchorview widget will create a hover
9378     * object to use as a popup with user provided content. This function
9379     * terminates this popup, returning the anchorview to its normal state.
9380     *
9381     * @param obj The anchorview object
9382     */
9383    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9384    /**
9385     * Set bouncing behaviour when the scrolled content reaches an edge
9386     *
9387     * Tell the internal scroller object whether it should bounce or not
9388     * when it reaches the respective edges for each axis.
9389     *
9390     * @param obj The anchorview object
9391     * @param h_bounce Whether to bounce or not in the horizontal axis
9392     * @param v_bounce Whether to bounce or not in the vertical axis
9393     *
9394     * @see elm_scroller_bounce_set()
9395     */
9396    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9397    /**
9398     * Get the set bouncing behaviour of the internal scroller
9399     *
9400     * Get whether the internal scroller should bounce when the edge of each
9401     * axis is reached scrolling.
9402     *
9403     * @param obj The anchorview object
9404     * @param h_bounce Pointer where to store the bounce state of the horizontal
9405     *                 axis
9406     * @param v_bounce Pointer where to store the bounce state of the vertical
9407     *                 axis
9408     *
9409     * @see elm_scroller_bounce_get()
9410     */
9411    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9412    /**
9413     * Appends a custom item provider to the given anchorview
9414     *
9415     * Appends the given function to the list of items providers. This list is
9416     * called, one function at a time, with the given @p data pointer, the
9417     * anchorview object and, in the @p item parameter, the item name as
9418     * referenced in its href string. Following functions in the list will be
9419     * called in order until one of them returns something different to NULL,
9420     * which should be an Evas_Object which will be used in place of the item
9421     * element.
9422     *
9423     * Items in the markup text take the form \<item relsize=16x16 vsize=full
9424     * href=item/name\>\</item\>
9425     *
9426     * @param obj The anchorview object
9427     * @param func The function to add to the list of providers
9428     * @param data User data that will be passed to the callback function
9429     *
9430     * @see elm_entry_item_provider_append()
9431     */
9432    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);
9433    /**
9434     * Prepend a custom item provider to the given anchorview
9435     *
9436     * Like elm_anchorview_item_provider_append(), but it adds the function
9437     * @p func to the beginning of the list, instead of the end.
9438     *
9439     * @param obj The anchorview object
9440     * @param func The function to add to the list of providers
9441     * @param data User data that will be passed to the callback function
9442     */
9443    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);
9444    /**
9445     * Remove a custom item provider from the list of the given anchorview
9446     *
9447     * Removes the function and data pairing that matches @p func and @p data.
9448     * That is, unless the same function and same user data are given, the
9449     * function will not be removed from the list. This allows us to add the
9450     * same callback several times, with different @p data pointers and be
9451     * able to remove them later without conflicts.
9452     *
9453     * @param obj The anchorview object
9454     * @param func The function to remove from the list
9455     * @param data The data matching the function to remove from the list
9456     */
9457    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);
9458    /**
9459     * @}
9460     */
9461
9462    /* anchorblock */
9463    /**
9464     * @defgroup Anchorblock Anchorblock
9465     *
9466     * @image html img/widget/anchorblock/preview-00.png
9467     * @image latex img/widget/anchorblock/preview-00.eps
9468     *
9469     * Anchorblock is for displaying text that contains markup with anchors
9470     * like <c>\<a href=1234\>something\</\></c> in it.
9471     *
9472     * Besides being styled differently, the anchorblock widget provides the
9473     * necessary functionality so that clicking on these anchors brings up a
9474     * popup with user defined content such as "call", "add to contacts" or
9475     * "open web page". This popup is provided using the @ref Hover widget.
9476     *
9477     * This widget emits the following signals:
9478     * @li "anchor,clicked": will be called when an anchor is clicked. The
9479     * @p event_info parameter on the callback will be a pointer of type
9480     * ::Elm_Entry_Anchorblock_Info.
9481     *
9482     * @see Anchorview
9483     * @see Entry
9484     * @see Hover
9485     *
9486     * Since examples are usually better than plain words, we might as well
9487     * try @ref tutorial_anchorblock_example "one".
9488     */
9489    /**
9490     * @addtogroup Anchorblock
9491     * @{
9492     */
9493    /**
9494     * @typedef Elm_Entry_Anchorblock_Info
9495     *
9496     * The info sent in the callback for "anchor,clicked" signals emitted by
9497     * the Anchorblock widget.
9498     */
9499    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9500    /**
9501     * @struct _Elm_Entry_Anchorblock_Info
9502     *
9503     * The info sent in the callback for "anchor,clicked" signals emitted by
9504     * the Anchorblock widget.
9505     */
9506    struct _Elm_Entry_Anchorblock_Info
9507      {
9508         const char     *name; /**< Name of the anchor, as indicated in its href
9509                                    attribute */
9510         int             button; /**< The mouse button used to click on it */
9511         Evas_Object    *hover; /**< The hover object to use for the popup */
9512         struct {
9513              Evas_Coord    x, y, w, h;
9514         } anchor, /**< Geometry selection of text used as anchor */
9515           hover_parent; /**< Geometry of the object used as parent by the
9516                              hover */
9517         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
9518                                              for content on the left side of
9519                                              the hover. Before calling the
9520                                              callback, the widget will make the
9521                                              necessary calculations to check
9522                                              which sides are fit to be set with
9523                                              content, based on the position the
9524                                              hover is activated and its distance
9525                                              to the edges of its parent object
9526                                              */
9527         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
9528                                               the right side of the hover.
9529                                               See @ref hover_left */
9530         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
9531                                             of the hover. See @ref hover_left */
9532         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
9533                                                below the hover. See @ref
9534                                                hover_left */
9535      };
9536    /**
9537     * Add a new Anchorblock object
9538     *
9539     * @param parent The parent object
9540     * @return The new object or NULL if it cannot be created
9541     */
9542    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9543    /**
9544     * Set the text to show in the anchorblock
9545     *
9546     * Sets the text of the anchorblock to @p text. This text can include markup
9547     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9548     * of text that will be specially styled and react to click events, ended
9549     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9550     * "anchor,clicked" signal that you can attach a callback to with
9551     * evas_object_smart_callback_add(). The name of the anchor given in the
9552     * event info struct will be the one set in the href attribute, in this
9553     * case, anchorname.
9554     *
9555     * Other markup can be used to style the text in different ways, but it's
9556     * up to the style defined in the theme which tags do what.
9557     * @deprecated use elm_object_text_set() instead.
9558     */
9559    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9560    /**
9561     * Get the markup text set for the anchorblock
9562     *
9563     * Retrieves the text set on the anchorblock, with markup tags included.
9564     *
9565     * @param obj The anchorblock object
9566     * @return The markup text set or @c NULL if nothing was set or an error
9567     * occurred
9568     * @deprecated use elm_object_text_set() instead.
9569     */
9570    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9571    /**
9572     * Set the parent of the hover popup
9573     *
9574     * Sets the parent object to use by the hover created by the anchorblock
9575     * when an anchor is clicked. See @ref Hover for more details on this.
9576     *
9577     * @param obj The anchorblock object
9578     * @param parent The object to use as parent for the hover
9579     */
9580    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9581    /**
9582     * Get the parent of the hover popup
9583     *
9584     * Get the object used as parent for the hover created by the anchorblock
9585     * widget. See @ref Hover for more details on this.
9586     * If no parent is set, the same anchorblock object will be used.
9587     *
9588     * @param obj The anchorblock object
9589     * @return The object used as parent for the hover, NULL if none is set.
9590     */
9591    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9592    /**
9593     * Set the style that the hover should use
9594     *
9595     * When creating the popup hover, anchorblock will request that it's
9596     * themed according to @p style.
9597     *
9598     * @param obj The anchorblock object
9599     * @param style The style to use for the underlying hover
9600     *
9601     * @see elm_object_style_set()
9602     */
9603    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9604    /**
9605     * Get the style that the hover should use
9606     *
9607     * Get the style the hover created by anchorblock will use.
9608     *
9609     * @param obj The anchorblock object
9610     * @return The style to use by the hover. NULL means the default is used.
9611     *
9612     * @see elm_object_style_set()
9613     */
9614    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9615    /**
9616     * Ends the hover popup in the anchorblock
9617     *
9618     * When an anchor is clicked, the anchorblock widget will create a hover
9619     * object to use as a popup with user provided content. This function
9620     * terminates this popup, returning the anchorblock to its normal state.
9621     *
9622     * @param obj The anchorblock object
9623     */
9624    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9625    /**
9626     * Appends a custom item provider to the given anchorblock
9627     *
9628     * Appends the given function to the list of items providers. This list is
9629     * called, one function at a time, with the given @p data pointer, the
9630     * anchorblock object and, in the @p item parameter, the item name as
9631     * referenced in its href string. Following functions in the list will be
9632     * called in order until one of them returns something different to NULL,
9633     * which should be an Evas_Object which will be used in place of the item
9634     * element.
9635     *
9636     * Items in the markup text take the form \<item relsize=16x16 vsize=full
9637     * href=item/name\>\</item\>
9638     *
9639     * @param obj The anchorblock object
9640     * @param func The function to add to the list of providers
9641     * @param data User data that will be passed to the callback function
9642     *
9643     * @see elm_entry_item_provider_append()
9644     */
9645    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);
9646    /**
9647     * Prepend a custom item provider to the given anchorblock
9648     *
9649     * Like elm_anchorblock_item_provider_append(), but it adds the function
9650     * @p func to the beginning of the list, instead of the end.
9651     *
9652     * @param obj The anchorblock object
9653     * @param func The function to add to the list of providers
9654     * @param data User data that will be passed to the callback function
9655     */
9656    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);
9657    /**
9658     * Remove a custom item provider from the list of the given anchorblock
9659     *
9660     * Removes the function and data pairing that matches @p func and @p data.
9661     * That is, unless the same function and same user data are given, the
9662     * function will not be removed from the list. This allows us to add the
9663     * same callback several times, with different @p data pointers and be
9664     * able to remove them later without conflicts.
9665     *
9666     * @param obj The anchorblock object
9667     * @param func The function to remove from the list
9668     * @param data The data matching the function to remove from the list
9669     */
9670    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);
9671    /**
9672     * @}
9673     */
9674
9675    /**
9676     * @defgroup Bubble Bubble
9677     *
9678     * @image html img/widget/bubble/preview-00.png
9679     * @image html img/widget/bubble/preview-01.png
9680     * @image html img/widget/bubble/preview-02.png
9681     *
9682     * @brief The Bubble is a widget to show text similarly to how speech is
9683     * represented in comics.
9684     *
9685     * The bubble widget contains 5 important visual elements:
9686     * @li The frame is a rectangle with rounded rectangles and an "arrow".
9687     * @li The @p icon is an image to which the frame's arrow points to.
9688     * @li The @p label is a text which appears to the right of the icon if the
9689     * corner is "top_left" or "bottom_left" and is right aligned to the frame
9690     * otherwise.
9691     * @li The @p info is a text which appears to the right of the label. Info's
9692     * font is of a ligther color than label.
9693     * @li The @p content is an evas object that is shown inside the frame.
9694     *
9695     * The position of the arrow, icon, label and info depends on which corner is
9696     * selected. The four available corners are:
9697     * @li "top_left" - Default
9698     * @li "top_right"
9699     * @li "bottom_left"
9700     * @li "bottom_right"
9701     *
9702     * Signals that you can add callbacks for are:
9703     * @li "clicked" - This is called when a user has clicked the bubble.
9704     *
9705     * For an example of using a buble see @ref bubble_01_example_page "this".
9706     *
9707     * @{
9708     */
9709    /**
9710     * Add a new bubble to the parent
9711     *
9712     * @param parent The parent object
9713     * @return The new object or NULL if it cannot be created
9714     *
9715     * This function adds a text bubble to the given parent evas object.
9716     */
9717    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9718    /**
9719     * Set the label of the bubble
9720     *
9721     * @param obj The bubble object
9722     * @param label The string to set in the label
9723     *
9724     * This function sets the title of the bubble. Where this appears depends on
9725     * the selected corner.
9726     * @deprecated use elm_object_text_set() instead.
9727     */
9728    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9729    /**
9730     * Get the label of the bubble
9731     *
9732     * @param obj The bubble object
9733     * @return The string of set in the label
9734     *
9735     * This function gets the title of the bubble.
9736     * @deprecated use elm_object_text_set() instead.
9737     */
9738    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9739    /**
9740     * Set the info of the bubble
9741     *
9742     * @param obj The bubble object
9743     * @param info The given info about the bubble
9744     *
9745     * This function sets the info of the bubble. Where this appears depends on
9746     * the selected corner.
9747     * @deprecated use elm_object_text_set() instead.
9748     */
9749    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9750    /**
9751     * Get the info of the bubble
9752     *
9753     * @param obj The bubble object
9754     *
9755     * @return The "info" string of the bubble
9756     *
9757     * This function gets the info text.
9758     * @deprecated use elm_object_text_set() instead.
9759     */
9760    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9761    /**
9762     * Set the content to be shown in the bubble
9763     *
9764     * Once the content object is set, a previously set one will be deleted.
9765     * If you want to keep the old content object, use the
9766     * elm_bubble_content_unset() function.
9767     *
9768     * @param obj The bubble object
9769     * @param content The given content of the bubble
9770     *
9771     * This function sets the content shown on the middle of the bubble.
9772     */
9773    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9774    /**
9775     * Get the content shown in the bubble
9776     *
9777     * Return the content object which is set for this widget.
9778     *
9779     * @param obj The bubble object
9780     * @return The content that is being used
9781     */
9782    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9783    /**
9784     * Unset the content shown in the bubble
9785     *
9786     * Unparent and return the content object which was set for this widget.
9787     *
9788     * @param obj The bubble object
9789     * @return The content that was being used
9790     */
9791    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9792    /**
9793     * Set the icon of the bubble
9794     *
9795     * Once the icon object is set, a previously set one will be deleted.
9796     * If you want to keep the old content object, use the
9797     * elm_icon_content_unset() function.
9798     *
9799     * @param obj The bubble object
9800     * @param icon The given icon for the bubble
9801     */
9802    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9803    /**
9804     * Get the icon of the bubble
9805     *
9806     * @param obj The bubble object
9807     * @return The icon for the bubble
9808     *
9809     * This function gets the icon shown on the top left of bubble.
9810     */
9811    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9812    /**
9813     * Unset the icon of the bubble
9814     *
9815     * Unparent and return the icon object which was set for this widget.
9816     *
9817     * @param obj The bubble object
9818     * @return The icon that was being used
9819     */
9820    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9821    /**
9822     * Set the corner of the bubble
9823     *
9824     * @param obj The bubble object.
9825     * @param corner The given corner for the bubble.
9826     *
9827     * This function sets the corner of the bubble. The corner will be used to
9828     * determine where the arrow in the frame points to and where label, icon and
9829     * info arre shown.
9830     *
9831     * Possible values for corner are:
9832     * @li "top_left" - Default
9833     * @li "top_right"
9834     * @li "bottom_left"
9835     * @li "bottom_right"
9836     */
9837    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
9838    /**
9839     * Get the corner of the bubble
9840     *
9841     * @param obj The bubble object.
9842     * @return The given corner for the bubble.
9843     *
9844     * This function gets the selected corner of the bubble.
9845     */
9846    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9847    /**
9848     * @}
9849     */
9850
9851    /* photo */
9852    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9853    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
9854    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
9855    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
9856    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
9857    /* smart callbacks called:
9858     * "clicked" - the user clicked the icon
9859     * "drag,start" - Someone started dragging the image out of the object
9860     * "drag,end" - Dragged item was dropped (somewhere)
9861     */
9862
9863    /* gesture layer */
9864    /**
9865     * @defgroup Elm_Gesture_Layer Gesture Layer
9866     * Gesture Layer Usage:
9867     *
9868     * Use Gesture Layer to detect gestures.
9869     * The advantage is that you don't have to implement
9870     * gesture detection, just set callbacks of gesture state.
9871     * By using gesture layer we make standard interface.
9872     *
9873     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
9874     * with a parent object parameter.
9875     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
9876     * call. Usually with same object as target (2nd parameter).
9877     *
9878     * Now you need to tell gesture layer what gestures you follow.
9879     * This is done with @ref elm_gesture_layer_cb_set call.
9880     * By setting the callback you actually saying to gesture layer:
9881     * I would like to know when the gesture @ref Elm_Gesture_Types
9882     * switches to state @ref Elm_Gesture_State.
9883     *
9884     * Next, you need to implement the actual action that follows the input
9885     * in your callback.
9886     *
9887     * Note that if you like to stop being reported about a gesture, just set
9888     * all callbacks referring this gesture to NULL.
9889     * (again with @ref elm_gesture_layer_cb_set)
9890     *
9891     * The information reported by gesture layer to your callback is depending
9892     * on @ref Elm_Gesture_Types:
9893     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
9894     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
9895     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
9896     *
9897     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
9898     * @ref ELM_GESTURE_MOMENTUM.
9899     *
9900     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
9901     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
9902     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
9903     * Note that we consider a flick as a line-gesture that should be completed
9904     * in flick-time-limit as defined in @ref Config.
9905     *
9906     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
9907     *
9908     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
9909     * */
9910
9911    /**
9912     * @enum _Elm_Gesture_Types
9913     * Enum of supported gesture types.
9914     * @ingroup Elm_Gesture_Layer
9915     */
9916    enum _Elm_Gesture_Types
9917      {
9918         ELM_GESTURE_FIRST = 0,
9919
9920         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
9921         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
9922         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
9923         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
9924
9925         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
9926
9927         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
9928         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
9929
9930         ELM_GESTURE_ZOOM, /**< Zoom */
9931         ELM_GESTURE_ROTATE, /**< Rotate */
9932
9933         ELM_GESTURE_LAST
9934      };
9935
9936    /**
9937     * @typedef Elm_Gesture_Types
9938     * gesture types enum
9939     * @ingroup Elm_Gesture_Layer
9940     */
9941    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
9942
9943    /**
9944     * @enum _Elm_Gesture_State
9945     * Enum of gesture states.
9946     * @ingroup Elm_Gesture_Layer
9947     */
9948    enum _Elm_Gesture_State
9949      {
9950         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
9951         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
9952         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
9953         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
9954         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
9955      };
9956
9957    /**
9958     * @typedef Elm_Gesture_State
9959     * gesture states enum
9960     * @ingroup Elm_Gesture_Layer
9961     */
9962    typedef enum _Elm_Gesture_State Elm_Gesture_State;
9963
9964    /**
9965     * @struct _Elm_Gesture_Taps_Info
9966     * Struct holds taps info for user
9967     * @ingroup Elm_Gesture_Layer
9968     */
9969    struct _Elm_Gesture_Taps_Info
9970      {
9971         Evas_Coord x, y;         /**< Holds center point between fingers */
9972         unsigned int n;          /**< Number of fingers tapped           */
9973         unsigned int timestamp;  /**< event timestamp       */
9974      };
9975
9976    /**
9977     * @typedef Elm_Gesture_Taps_Info
9978     * holds taps info for user
9979     * @ingroup Elm_Gesture_Layer
9980     */
9981    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
9982
9983    /**
9984     * @struct _Elm_Gesture_Momentum_Info
9985     * Struct holds momentum info for user
9986     * x1 and y1 are not necessarily in sync
9987     * x1 holds x value of x direction starting point
9988     * and same holds for y1.
9989     * This is noticeable when doing V-shape movement
9990     * @ingroup Elm_Gesture_Layer
9991     */
9992    struct _Elm_Gesture_Momentum_Info
9993      {  /* Report line ends, timestamps, and momentum computed        */
9994         Evas_Coord x1; /**< Final-swipe direction starting point on X */
9995         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
9996         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
9997         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
9998
9999         unsigned int tx; /**< Timestamp of start of final x-swipe */
10000         unsigned int ty; /**< Timestamp of start of final y-swipe */
10001
10002         Evas_Coord mx; /**< Momentum on X */
10003         Evas_Coord my; /**< Momentum on Y */
10004      };
10005
10006    /**
10007     * @typedef Elm_Gesture_Momentum_Info
10008     * holds momentum info for user
10009     * @ingroup Elm_Gesture_Layer
10010     */
10011     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10012
10013    /**
10014     * @struct _Elm_Gesture_Line_Info
10015     * Struct holds line info for user
10016     * @ingroup Elm_Gesture_Layer
10017     */
10018    struct _Elm_Gesture_Line_Info
10019      {  /* Report line ends, timestamps, and momentum computed      */
10020         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10021         unsigned int n;            /**< Number of fingers (lines)   */
10022         /* FIXME should be radians, bot degrees */
10023         double angle;              /**< Angle (direction) of lines  */
10024      };
10025
10026    /**
10027     * @typedef Elm_Gesture_Line_Info
10028     * Holds line info for user
10029     * @ingroup Elm_Gesture_Layer
10030     */
10031     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10032
10033    /**
10034     * @struct _Elm_Gesture_Zoom_Info
10035     * Struct holds zoom info for user
10036     * @ingroup Elm_Gesture_Layer
10037     */
10038    struct _Elm_Gesture_Zoom_Info
10039      {
10040         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
10041         Evas_Coord radius; /**< Holds radius between fingers reported to user */
10042         double zoom;            /**< Zoom value: 1.0 means no zoom             */
10043         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10044      };
10045
10046    /**
10047     * @typedef Elm_Gesture_Zoom_Info
10048     * Holds zoom info for user
10049     * @ingroup Elm_Gesture_Layer
10050     */
10051    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10052
10053    /**
10054     * @struct _Elm_Gesture_Rotate_Info
10055     * Struct holds rotation info for user
10056     * @ingroup Elm_Gesture_Layer
10057     */
10058    struct _Elm_Gesture_Rotate_Info
10059      {
10060         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
10061         Evas_Coord radius; /**< Holds radius between fingers reported to user */
10062         double base_angle; /**< Holds start-angle */
10063         double angle;      /**< Rotation value: 0.0 means no rotation         */
10064         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10065      };
10066
10067    /**
10068     * @typedef Elm_Gesture_Rotate_Info
10069     * Holds rotation info for user
10070     * @ingroup Elm_Gesture_Layer
10071     */
10072    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10073
10074    /**
10075     * @typedef Elm_Gesture_Event_Cb
10076     * User callback used to stream gesture info from gesture layer
10077     * @param data user data
10078     * @param event_info gesture report info
10079     * Returns a flag field to be applied on the causing event.
10080     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10081     * upon the event, in an irreversible way.
10082     *
10083     * @ingroup Elm_Gesture_Layer
10084     */
10085    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10086
10087    /**
10088     * Use function to set callbacks to be notified about
10089     * change of state of gesture.
10090     * When a user registers a callback with this function
10091     * this means this gesture has to be tested.
10092     *
10093     * When ALL callbacks for a gesture are set to NULL
10094     * it means user isn't interested in gesture-state
10095     * and it will not be tested.
10096     *
10097     * @param obj Pointer to gesture-layer.
10098     * @param idx The gesture you would like to track its state.
10099     * @param cb callback function pointer.
10100     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10101     * @param data user info to be sent to callback (usually, Smart Data)
10102     *
10103     * @ingroup Elm_Gesture_Layer
10104     */
10105    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);
10106
10107    /**
10108     * Call this function to get repeat-events settings.
10109     *
10110     * @param obj Pointer to gesture-layer.
10111     *
10112     * @return repeat events settings.
10113     * @see elm_gesture_layer_hold_events_set()
10114     * @ingroup Elm_Gesture_Layer
10115     */
10116    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10117
10118    /**
10119     * This function called in order to make gesture-layer repeat events.
10120     * Set this of you like to get the raw events only if gestures were not detected.
10121     * Clear this if you like gesture layer to fwd events as testing gestures.
10122     *
10123     * @param obj Pointer to gesture-layer.
10124     * @param r Repeat: TRUE/FALSE
10125     *
10126     * @ingroup Elm_Gesture_Layer
10127     */
10128    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10129
10130    /**
10131     * This function sets step-value for zoom action.
10132     * Set step to any positive value.
10133     * Cancel step setting by setting to 0.0
10134     *
10135     * @param obj Pointer to gesture-layer.
10136     * @param s new zoom step value.
10137     *
10138     * @ingroup Elm_Gesture_Layer
10139     */
10140    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10141
10142    /**
10143     * This function sets step-value for rotate action.
10144     * Set step to any positive value.
10145     * Cancel step setting by setting to 0.0
10146     *
10147     * @param obj Pointer to gesture-layer.
10148     * @param s new roatate step value.
10149     *
10150     * @ingroup Elm_Gesture_Layer
10151     */
10152    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10153
10154    /**
10155     * This function called to attach gesture-layer to an Evas_Object.
10156     * @param obj Pointer to gesture-layer.
10157     * @param t Pointer to underlying object (AKA Target)
10158     *
10159     * @return TRUE, FALSE on success, failure.
10160     *
10161     * @ingroup Elm_Gesture_Layer
10162     */
10163    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10164
10165    /**
10166     * Call this function to construct a new gesture-layer object.
10167     * This does not activate the gesture layer. You have to
10168     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10169     *
10170     * @param parent the parent object.
10171     *
10172     * @return Pointer to new gesture-layer object.
10173     *
10174     * @ingroup Elm_Gesture_Layer
10175     */
10176    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10177
10178    /**
10179     * @defgroup Thumb Thumb
10180     *
10181     * @image html img/widget/thumb/preview-00.png
10182     * @image latex img/widget/thumb/preview-00.eps
10183     *
10184     * A thumb object is used for displaying the thumbnail of an image or video.
10185     * You must have compiled Elementary with Ethumb_Client support and the DBus
10186     * service must be present and auto-activated in order to have thumbnails to
10187     * be generated.
10188     *
10189     * Once the thumbnail object becomes visible, it will check if there is a
10190     * previously generated thumbnail image for the file set on it. If not, it
10191     * will start generating this thumbnail.
10192     *
10193     * Different config settings will cause different thumbnails to be generated
10194     * even on the same file.
10195     *
10196     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10197     * Ethumb documentation to change this path, and to see other configuration
10198     * options.
10199     *
10200     * Signals that you can add callbacks for are:
10201     *
10202     * - "clicked" - This is called when a user has clicked the thumb without dragging
10203     *             around.
10204     * - "clicked,double" - This is called when a user has double-clicked the thumb.
10205     * - "press" - This is called when a user has pressed down the thumb.
10206     * - "generate,start" - The thumbnail generation started.
10207     * - "generate,stop" - The generation process stopped.
10208     * - "generate,error" - The generation failed.
10209     * - "load,error" - The thumbnail image loading failed.
10210     *
10211     * available styles:
10212     * - default
10213     * - noframe
10214     *
10215     * An example of use of thumbnail:
10216     *
10217     * - @ref thumb_example_01
10218     */
10219
10220    /**
10221     * @addtogroup Thumb
10222     * @{
10223     */
10224
10225    /**
10226     * @enum _Elm_Thumb_Animation_Setting
10227     * @typedef Elm_Thumb_Animation_Setting
10228     *
10229     * Used to set if a video thumbnail is animating or not.
10230     *
10231     * @ingroup Thumb
10232     */
10233    typedef enum _Elm_Thumb_Animation_Setting
10234      {
10235         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10236         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
10237         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
10238         ELM_THUMB_ANIMATION_LAST
10239      } Elm_Thumb_Animation_Setting;
10240
10241    /**
10242     * Add a new thumb object to the parent.
10243     *
10244     * @param parent The parent object.
10245     * @return The new object or NULL if it cannot be created.
10246     *
10247     * @see elm_thumb_file_set()
10248     * @see elm_thumb_ethumb_client_get()
10249     *
10250     * @ingroup Thumb
10251     */
10252    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10253    /**
10254     * Reload thumbnail if it was generated before.
10255     *
10256     * @param obj The thumb object to reload
10257     *
10258     * This is useful if the ethumb client configuration changed, like its
10259     * size, aspect or any other property one set in the handle returned
10260     * by elm_thumb_ethumb_client_get().
10261     *
10262     * If the options didn't change, the thumbnail won't be generated again, but
10263     * the old one will still be used.
10264     *
10265     * @see elm_thumb_file_set()
10266     *
10267     * @ingroup Thumb
10268     */
10269    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10270    /**
10271     * Set the file that will be used as thumbnail.
10272     *
10273     * @param obj The thumb object.
10274     * @param file The path to file that will be used as thumb.
10275     * @param key The key used in case of an EET file.
10276     *
10277     * The file can be an image or a video (in that case, acceptable extensions are:
10278     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10279     * function elm_thumb_animate().
10280     *
10281     * @see elm_thumb_file_get()
10282     * @see elm_thumb_reload()
10283     * @see elm_thumb_animate()
10284     *
10285     * @ingroup Thumb
10286     */
10287    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10288    /**
10289     * Get the image or video path and key used to generate the thumbnail.
10290     *
10291     * @param obj The thumb object.
10292     * @param file Pointer to filename.
10293     * @param key Pointer to key.
10294     *
10295     * @see elm_thumb_file_set()
10296     * @see elm_thumb_path_get()
10297     *
10298     * @ingroup Thumb
10299     */
10300    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10301    /**
10302     * Get the path and key to the image or video generated by ethumb.
10303     *
10304     * One just need to make sure that the thumbnail was generated before getting
10305     * its path; otherwise, the path will be NULL. One way to do that is by asking
10306     * for the path when/after the "generate,stop" smart callback is called.
10307     *
10308     * @param obj The thumb object.
10309     * @param file Pointer to thumb path.
10310     * @param key Pointer to thumb key.
10311     *
10312     * @see elm_thumb_file_get()
10313     *
10314     * @ingroup Thumb
10315     */
10316    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10317    /**
10318     * Set the animation state for the thumb object. If its content is an animated
10319     * video, you may start/stop the animation or tell it to play continuously and
10320     * looping.
10321     *
10322     * @param obj The thumb object.
10323     * @param setting The animation setting.
10324     *
10325     * @see elm_thumb_file_set()
10326     *
10327     * @ingroup Thumb
10328     */
10329    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10330    /**
10331     * Get the animation state for the thumb object.
10332     *
10333     * @param obj The thumb object.
10334     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10335     * on errors.
10336     *
10337     * @see elm_thumb_animate_set()
10338     *
10339     * @ingroup Thumb
10340     */
10341    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10342    /**
10343     * Get the ethumb_client handle so custom configuration can be made.
10344     *
10345     * @return Ethumb_Client instance or NULL.
10346     *
10347     * This must be called before the objects are created to be sure no object is
10348     * visible and no generation started.
10349     *
10350     * Example of usage:
10351     *
10352     * @code
10353     * #include <Elementary.h>
10354     * #ifndef ELM_LIB_QUICKLAUNCH
10355     * EAPI int
10356     * elm_main(int argc, char **argv)
10357     * {
10358     *    Ethumb_Client *client;
10359     *
10360     *    elm_need_ethumb();
10361     *
10362     *    // ... your code
10363     *
10364     *    client = elm_thumb_ethumb_client_get();
10365     *    if (!client)
10366     *      {
10367     *         ERR("could not get ethumb_client");
10368     *         return 1;
10369     *      }
10370     *    ethumb_client_size_set(client, 100, 100);
10371     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
10372     *    // ... your code
10373     *
10374     *    // Create elm_thumb objects here
10375     *
10376     *    elm_run();
10377     *    elm_shutdown();
10378     *    return 0;
10379     * }
10380     * #endif
10381     * ELM_MAIN()
10382     * @endcode
10383     *
10384     * @note There's only one client handle for Ethumb, so once a configuration
10385     * change is done to it, any other request for thumbnails (for any thumbnail
10386     * object) will use that configuration. Thus, this configuration is global.
10387     *
10388     * @ingroup Thumb
10389     */
10390    EAPI void                        *elm_thumb_ethumb_client_get(void);
10391    /**
10392     * Get the ethumb_client connection state.
10393     *
10394     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10395     * otherwise.
10396     */
10397    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
10398    /**
10399     * Make the thumbnail 'editable'.
10400     *
10401     * @param obj Thumb object.
10402     * @param set Turn on or off editability. Default is @c EINA_FALSE.
10403     *
10404     * This means the thumbnail is a valid drag target for drag and drop, and can be
10405     * cut or pasted too.
10406     *
10407     * @see elm_thumb_editable_get()
10408     *
10409     * @ingroup Thumb
10410     */
10411    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10412    /**
10413     * Make the thumbnail 'editable'.
10414     *
10415     * @param obj Thumb object.
10416     * @return Editability.
10417     *
10418     * This means the thumbnail is a valid drag target for drag and drop, and can be
10419     * cut or pasted too.
10420     *
10421     * @see elm_thumb_editable_set()
10422     *
10423     * @ingroup Thumb
10424     */
10425    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10426
10427    /**
10428     * @}
10429     */
10430
10431    /**
10432     * @defgroup Hoversel Hoversel
10433     *
10434     * @image html img/widget/hoversel/preview-00.png
10435     * @image latex img/widget/hoversel/preview-00.eps
10436     *
10437     * A hoversel is a button that pops up a list of items (automatically
10438     * choosing the direction to display) that have a label and, optionally, an
10439     * icon to select from. It is a convenience widget to avoid the need to do
10440     * all the piecing together yourself. It is intended for a small number of
10441     * items in the hoversel menu (no more than 8), though is capable of many
10442     * more.
10443     *
10444     * Signals that you can add callbacks for are:
10445     * "clicked" - the user clicked the hoversel button and popped up the sel
10446     * "selected" - an item in the hoversel list is selected. event_info is the item
10447     * "dismissed" - the hover is dismissed
10448     *
10449     * See @ref tutorial_hoversel for an example.
10450     * @{
10451     */
10452    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10453    /**
10454     * @brief Add a new Hoversel object
10455     *
10456     * @param parent The parent object
10457     * @return The new object or NULL if it cannot be created
10458     */
10459    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10460    /**
10461     * @brief This sets the hoversel to expand horizontally.
10462     *
10463     * @param obj The hoversel object
10464     * @param horizontal If true, the hover will expand horizontally to the
10465     * right.
10466     *
10467     * @note The initial button will display horizontally regardless of this
10468     * setting.
10469     */
10470    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10471    /**
10472     * @brief This returns whether the hoversel is set to expand horizontally.
10473     *
10474     * @param obj The hoversel object
10475     * @return If true, the hover will expand horizontally to the right.
10476     *
10477     * @see elm_hoversel_horizontal_set()
10478     */
10479    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10480    /**
10481     * @brief Set the Hover parent
10482     *
10483     * @param obj The hoversel object
10484     * @param parent The parent to use
10485     *
10486     * Sets the hover parent object, the area that will be darkened when the
10487     * hoversel is clicked. Should probably be the window that the hoversel is
10488     * in. See @ref Hover objects for more information.
10489     */
10490    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10491    /**
10492     * @brief Get the Hover parent
10493     *
10494     * @param obj The hoversel object
10495     * @return The used parent
10496     *
10497     * Gets the hover parent object.
10498     *
10499     * @see elm_hoversel_hover_parent_set()
10500     */
10501    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10502    /**
10503     * @brief Set the hoversel button label
10504     *
10505     * @param obj The hoversel object
10506     * @param label The label text.
10507     *
10508     * This sets the label of the button that is always visible (before it is
10509     * clicked and expanded).
10510     *
10511     * @deprecated elm_object_text_set()
10512     */
10513    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10514    /**
10515     * @brief Get the hoversel button label
10516     *
10517     * @param obj The hoversel object
10518     * @return The label text.
10519     *
10520     * @deprecated elm_object_text_get()
10521     */
10522    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10523    /**
10524     * @brief Set the icon of the hoversel button
10525     *
10526     * @param obj The hoversel object
10527     * @param icon The icon object
10528     *
10529     * Sets the icon of the button that is always visible (before it is clicked
10530     * and expanded).  Once the icon object is set, a previously set one will be
10531     * deleted, if you want to keep that old content object, use the
10532     * elm_hoversel_icon_unset() function.
10533     *
10534     * @see elm_button_icon_set()
10535     */
10536    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10537    /**
10538     * @brief Get the icon of the hoversel button
10539     *
10540     * @param obj The hoversel object
10541     * @return The icon object
10542     *
10543     * Get the icon of the button that is always visible (before it is clicked
10544     * and expanded). Also see elm_button_icon_get().
10545     *
10546     * @see elm_hoversel_icon_set()
10547     */
10548    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10549    /**
10550     * @brief Get and unparent the icon of the hoversel button
10551     *
10552     * @param obj The hoversel object
10553     * @return The icon object that was being used
10554     *
10555     * Unparent and return the icon of the button that is always visible
10556     * (before it is clicked and expanded).
10557     *
10558     * @see elm_hoversel_icon_set()
10559     * @see elm_button_icon_unset()
10560     */
10561    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10562    /**
10563     * @brief This triggers the hoversel popup from code, the same as if the user
10564     * had clicked the button.
10565     *
10566     * @param obj The hoversel object
10567     */
10568    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10569    /**
10570     * @brief This dismisses the hoversel popup as if the user had clicked
10571     * outside the hover.
10572     *
10573     * @param obj The hoversel object
10574     */
10575    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10576    /**
10577     * @brief Returns whether the hoversel is expanded.
10578     *
10579     * @param obj The hoversel object
10580     * @return  This will return EINA_TRUE if the hoversel is expanded or
10581     * EINA_FALSE if it is not expanded.
10582     */
10583    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10584    /**
10585     * @brief This will remove all the children items from the hoversel.
10586     *
10587     * @param obj The hoversel object
10588     *
10589     * @warning Should @b not be called while the hoversel is active; use
10590     * elm_hoversel_expanded_get() to check first.
10591     *
10592     * @see elm_hoversel_item_del_cb_set()
10593     * @see elm_hoversel_item_del()
10594     */
10595    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10596    /**
10597     * @brief Get the list of items within the given hoversel.
10598     *
10599     * @param obj The hoversel object
10600     * @return Returns a list of Elm_Hoversel_Item*
10601     *
10602     * @see elm_hoversel_item_add()
10603     */
10604    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10605    /**
10606     * @brief Add an item to the hoversel button
10607     *
10608     * @param obj The hoversel object
10609     * @param label The text label to use for the item (NULL if not desired)
10610     * @param icon_file An image file path on disk to use for the icon or standard
10611     * icon name (NULL if not desired)
10612     * @param icon_type The icon type if relevant
10613     * @param func Convenience function to call when this item is selected
10614     * @param data Data to pass to item-related functions
10615     * @return A handle to the item added.
10616     *
10617     * This adds an item to the hoversel to show when it is clicked. Note: if you
10618     * need to use an icon from an edje file then use
10619     * elm_hoversel_item_icon_set() right after the this function, and set
10620     * icon_file to NULL here.
10621     *
10622     * For more information on what @p icon_file and @p icon_type are see the
10623     * @ref Icon "icon documentation".
10624     */
10625    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);
10626    /**
10627     * @brief Delete an item from the hoversel
10628     *
10629     * @param item The item to delete
10630     *
10631     * This deletes the item from the hoversel (should not be called while the
10632     * hoversel is active; use elm_hoversel_expanded_get() to check first).
10633     *
10634     * @see elm_hoversel_item_add()
10635     * @see elm_hoversel_item_del_cb_set()
10636     */
10637    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10638    /**
10639     * @brief Set the function to be called when an item from the hoversel is
10640     * freed.
10641     *
10642     * @param item The item to set the callback on
10643     * @param func The function called
10644     *
10645     * That function will receive these parameters:
10646     * @li void *item_data
10647     * @li Evas_Object *the_item_object
10648     * @li Elm_Hoversel_Item *the_object_struct
10649     *
10650     * @see elm_hoversel_item_add()
10651     */
10652    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10653    /**
10654     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10655     * that will be passed to associated function callbacks.
10656     *
10657     * @param item The item to get the data from
10658     * @return The data pointer set with elm_hoversel_item_add()
10659     *
10660     * @see elm_hoversel_item_add()
10661     */
10662    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10663    /**
10664     * @brief This returns the label text of the given hoversel item.
10665     *
10666     * @param item The item to get the label
10667     * @return The label text of the hoversel item
10668     *
10669     * @see elm_hoversel_item_add()
10670     */
10671    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10672    /**
10673     * @brief This sets the icon for the given hoversel item.
10674     *
10675     * @param item The item to set the icon
10676     * @param icon_file An image file path on disk to use for the icon or standard
10677     * icon name
10678     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10679     * to NULL if the icon is not an edje file
10680     * @param icon_type The icon type
10681     *
10682     * The icon can be loaded from the standard set, from an image file, or from
10683     * an edje file.
10684     *
10685     * @see elm_hoversel_item_add()
10686     */
10687    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);
10688    /**
10689     * @brief Get the icon object of the hoversel item
10690     *
10691     * @param item The item to get the icon from
10692     * @param icon_file The image file path on disk used for the icon or standard
10693     * icon name
10694     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10695     * if the icon is not an edje file
10696     * @param icon_type The icon type
10697     *
10698     * @see elm_hoversel_item_icon_set()
10699     * @see elm_hoversel_item_add()
10700     */
10701    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);
10702    /**
10703     * @}
10704     */
10705
10706    /**
10707     * @defgroup Toolbar Toolbar
10708     * @ingroup Elementary
10709     *
10710     * @image html img/widget/toolbar/preview-00.png
10711     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10712     *
10713     * @image html img/toolbar.png
10714     * @image latex img/toolbar.eps width=\textwidth
10715     *
10716     * A toolbar is a widget that displays a list of items inside
10717     * a box. It can be scrollable, show a menu with items that don't fit
10718     * to toolbar size or even crop them.
10719     *
10720     * Only one item can be selected at a time.
10721     *
10722     * Items can have multiple states, or show menus when selected by the user.
10723     *
10724     * Smart callbacks one can listen to:
10725     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10726     *
10727     * Available styles for it:
10728     * - @c "default"
10729     * - @c "transparent" - no background or shadow, just show the content
10730     *
10731     * List of examples:
10732     * @li @ref toolbar_example_01
10733     * @li @ref toolbar_example_02
10734     * @li @ref toolbar_example_03
10735     */
10736
10737    /**
10738     * @addtogroup Toolbar
10739     * @{
10740     */
10741
10742    /**
10743     * @enum _Elm_Toolbar_Shrink_Mode
10744     * @typedef Elm_Toolbar_Shrink_Mode
10745     *
10746     * Set toolbar's items display behavior, it can be scrollabel,
10747     * show a menu with exceeding items, or simply hide them.
10748     *
10749     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10750     * from elm config.
10751     *
10752     * Values <b> don't </b> work as bitmask, only one can be choosen.
10753     *
10754     * @see elm_toolbar_mode_shrink_set()
10755     * @see elm_toolbar_mode_shrink_get()
10756     *
10757     * @ingroup Toolbar
10758     */
10759    typedef enum _Elm_Toolbar_Shrink_Mode
10760      {
10761         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
10762         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
10763         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10764         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
10765      } Elm_Toolbar_Shrink_Mode;
10766
10767    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
10768
10769    typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /**< State of a Elm_Toolbar_Item. Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del(). */
10770
10771    /**
10772     * Add a new toolbar widget to the given parent Elementary
10773     * (container) object.
10774     *
10775     * @param parent The parent object.
10776     * @return a new toolbar widget handle or @c NULL, on errors.
10777     *
10778     * This function inserts a new toolbar widget on the canvas.
10779     *
10780     * @ingroup Toolbar
10781     */
10782    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10783
10784    /**
10785     * Set the icon size, in pixels, to be used by toolbar items.
10786     *
10787     * @param obj The toolbar object
10788     * @param icon_size The icon size in pixels
10789     *
10790     * @note Default value is @c 32. It reads value from elm config.
10791     *
10792     * @see elm_toolbar_icon_size_get()
10793     *
10794     * @ingroup Toolbar
10795     */
10796    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
10797
10798    /**
10799     * Get the icon size, in pixels, to be used by toolbar items.
10800     *
10801     * @param obj The toolbar object.
10802     * @return The icon size in pixels.
10803     *
10804     * @see elm_toolbar_icon_size_set() for details.
10805     *
10806     * @ingroup Toolbar
10807     */
10808    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10809
10810    /**
10811     * Sets icon lookup order, for toolbar items' icons.
10812     *
10813     * @param obj The toolbar object.
10814     * @param order The icon lookup order.
10815     *
10816     * Icons added before calling this function will not be affected.
10817     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
10818     *
10819     * @see elm_toolbar_icon_order_lookup_get()
10820     *
10821     * @ingroup Toolbar
10822     */
10823    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
10824
10825    /**
10826     * Gets the icon lookup order.
10827     *
10828     * @param obj The toolbar object.
10829     * @return The icon lookup order.
10830     *
10831     * @see elm_toolbar_icon_order_lookup_set() for details.
10832     *
10833     * @ingroup Toolbar
10834     */
10835    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10836
10837    /**
10838     * Set whether the toolbar items' should be selected by the user or not.
10839     *
10840     * @param obj The toolbar object.
10841     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
10842     * enable it.
10843     *
10844     * This will turn off the ability to select items entirely and they will
10845     * neither appear selected nor emit selected signals. The clicked
10846     * callback function will still be called.
10847     *
10848     * Selection is enabled by default.
10849     *
10850     * @see elm_toolbar_no_select_mode_get().
10851     *
10852     * @ingroup Toolbar
10853     */
10854    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10855
10856    /**
10857     * Set whether the toolbar items' should be selected by the user or not.
10858     *
10859     * @param obj The toolbar object.
10860     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
10861     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
10862     *
10863     * @see elm_toolbar_no_select_mode_set() for details.
10864     *
10865     * @ingroup Toolbar
10866     */
10867    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10868
10869    /**
10870     * Append item to the toolbar.
10871     *
10872     * @param obj The toolbar object.
10873     * @param icon A string with icon name or the absolute path of an image file.
10874     * @param label The label of the item.
10875     * @param func The function to call when the item is clicked.
10876     * @param data The data to associate with the item for related callbacks.
10877     * @return The created item or @c NULL upon failure.
10878     *
10879     * A new item will be created and appended to the toolbar, i.e., will
10880     * be set as @b last item.
10881     *
10882     * Items created with this method can be deleted with
10883     * elm_toolbar_item_del().
10884     *
10885     * Associated @p data can be properly freed when item is deleted if a
10886     * callback function is set with elm_toolbar_item_del_cb_set().
10887     *
10888     * If a function is passed as argument, it will be called everytime this item
10889     * is selected, i.e., the user clicks over an unselected item.
10890     * If such function isn't needed, just passing
10891     * @c NULL as @p func is enough. The same should be done for @p data.
10892     *
10893     * Toolbar will load icon image from fdo or current theme.
10894     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10895     * If an absolute path is provided it will load it direct from a file.
10896     *
10897     * @see elm_toolbar_item_icon_set()
10898     * @see elm_toolbar_item_del()
10899     * @see elm_toolbar_item_del_cb_set()
10900     *
10901     * @ingroup Toolbar
10902     */
10903    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);
10904
10905    /**
10906     * Prepend item to the toolbar.
10907     *
10908     * @param obj The toolbar object.
10909     * @param icon A string with icon name or the absolute path of an image file.
10910     * @param label The label of the item.
10911     * @param func The function to call when the item is clicked.
10912     * @param data The data to associate with the item for related callbacks.
10913     * @return The created item or @c NULL upon failure.
10914     *
10915     * A new item will be created and prepended to the toolbar, i.e., will
10916     * be set as @b first item.
10917     *
10918     * Items created with this method can be deleted with
10919     * elm_toolbar_item_del().
10920     *
10921     * Associated @p data can be properly freed when item is deleted if a
10922     * callback function is set with elm_toolbar_item_del_cb_set().
10923     *
10924     * If a function is passed as argument, it will be called everytime this item
10925     * is selected, i.e., the user clicks over an unselected item.
10926     * If such function isn't needed, just passing
10927     * @c NULL as @p func is enough. The same should be done for @p data.
10928     *
10929     * Toolbar will load icon image from fdo or current theme.
10930     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10931     * If an absolute path is provided it will load it direct from a file.
10932     *
10933     * @see elm_toolbar_item_icon_set()
10934     * @see elm_toolbar_item_del()
10935     * @see elm_toolbar_item_del_cb_set()
10936     *
10937     * @ingroup Toolbar
10938     */
10939    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);
10940
10941    /**
10942     * Insert a new item into the toolbar object before item @p before.
10943     *
10944     * @param obj The toolbar object.
10945     * @param before The toolbar item to insert before.
10946     * @param icon A string with icon name or the absolute path of an image file.
10947     * @param label The label of the item.
10948     * @param func The function to call when the item is clicked.
10949     * @param data The data to associate with the item for related callbacks.
10950     * @return The created item or @c NULL upon failure.
10951     *
10952     * A new item will be created and added to the toolbar. Its position in
10953     * this toolbar will be just before item @p before.
10954     *
10955     * Items created with this method can be deleted with
10956     * elm_toolbar_item_del().
10957     *
10958     * Associated @p data can be properly freed when item is deleted if a
10959     * callback function is set with elm_toolbar_item_del_cb_set().
10960     *
10961     * If a function is passed as argument, it will be called everytime this item
10962     * is selected, i.e., the user clicks over an unselected item.
10963     * If such function isn't needed, just passing
10964     * @c NULL as @p func is enough. The same should be done for @p data.
10965     *
10966     * Toolbar will load icon image from fdo or current theme.
10967     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10968     * If an absolute path is provided it will load it direct from a file.
10969     *
10970     * @see elm_toolbar_item_icon_set()
10971     * @see elm_toolbar_item_del()
10972     * @see elm_toolbar_item_del_cb_set()
10973     *
10974     * @ingroup Toolbar
10975     */
10976    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);
10977
10978    /**
10979     * Insert a new item into the toolbar object after item @p after.
10980     *
10981     * @param obj The toolbar object.
10982     * @param before The toolbar item to insert before.
10983     * @param icon A string with icon name or the absolute path of an image file.
10984     * @param label The label of the item.
10985     * @param func The function to call when the item is clicked.
10986     * @param data The data to associate with the item for related callbacks.
10987     * @return The created item or @c NULL upon failure.
10988     *
10989     * A new item will be created and added to the toolbar. Its position in
10990     * this toolbar will be just after item @p after.
10991     *
10992     * Items created with this method can be deleted with
10993     * elm_toolbar_item_del().
10994     *
10995     * Associated @p data can be properly freed when item is deleted if a
10996     * callback function is set with elm_toolbar_item_del_cb_set().
10997     *
10998     * If a function is passed as argument, it will be called everytime this item
10999     * is selected, i.e., the user clicks over an unselected item.
11000     * If such function isn't needed, just passing
11001     * @c NULL as @p func is enough. The same should be done for @p data.
11002     *
11003     * Toolbar will load icon image from fdo or current theme.
11004     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11005     * If an absolute path is provided it will load it direct from a file.
11006     *
11007     * @see elm_toolbar_item_icon_set()
11008     * @see elm_toolbar_item_del()
11009     * @see elm_toolbar_item_del_cb_set()
11010     *
11011     * @ingroup Toolbar
11012     */
11013    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);
11014
11015    /**
11016     * Get the first item in the given toolbar widget's list of
11017     * items.
11018     *
11019     * @param obj The toolbar object
11020     * @return The first item or @c NULL, if it has no items (and on
11021     * errors)
11022     *
11023     * @see elm_toolbar_item_append()
11024     * @see elm_toolbar_last_item_get()
11025     *
11026     * @ingroup Toolbar
11027     */
11028    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11029
11030    /**
11031     * Get the last item in the given toolbar widget's list of
11032     * items.
11033     *
11034     * @param obj The toolbar object
11035     * @return The last item or @c NULL, if it has no items (and on
11036     * errors)
11037     *
11038     * @see elm_toolbar_item_prepend()
11039     * @see elm_toolbar_first_item_get()
11040     *
11041     * @ingroup Toolbar
11042     */
11043    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11044
11045    /**
11046     * Get the item after @p item in toolbar.
11047     *
11048     * @param item The toolbar item.
11049     * @return The item after @p item, or @c NULL if none or on failure.
11050     *
11051     * @note If it is the last item, @c NULL will be returned.
11052     *
11053     * @see elm_toolbar_item_append()
11054     *
11055     * @ingroup Toolbar
11056     */
11057    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11058
11059    /**
11060     * Get the item before @p item in toolbar.
11061     *
11062     * @param item The toolbar item.
11063     * @return The item before @p item, or @c NULL if none or on failure.
11064     *
11065     * @note If it is the first item, @c NULL will be returned.
11066     *
11067     * @see elm_toolbar_item_prepend()
11068     *
11069     * @ingroup Toolbar
11070     */
11071    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11072
11073    /**
11074     * Get the toolbar object from an item.
11075     *
11076     * @param item The item.
11077     * @return The toolbar object.
11078     *
11079     * This returns the toolbar object itself that an item belongs to.
11080     *
11081     * @ingroup Toolbar
11082     */
11083    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11084
11085    /**
11086     * Set the priority of a toolbar item.
11087     *
11088     * @param item The toolbar item.
11089     * @param priority The item priority. The default is zero.
11090     *
11091     * This is used only when the toolbar shrink mode is set to
11092     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11093     * When space is less than required, items with low priority
11094     * will be removed from the toolbar and added to a dynamically-created menu,
11095     * while items with higher priority will remain on the toolbar,
11096     * with the same order they were added.
11097     *
11098     * @see elm_toolbar_item_priority_get()
11099     *
11100     * @ingroup Toolbar
11101     */
11102    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11103
11104    /**
11105     * Get the priority of a toolbar item.
11106     *
11107     * @param item The toolbar item.
11108     * @return The @p item priority, or @c 0 on failure.
11109     *
11110     * @see elm_toolbar_item_priority_set() for details.
11111     *
11112     * @ingroup Toolbar
11113     */
11114    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11115
11116    /**
11117     * Get the label of item.
11118     *
11119     * @param item The item of toolbar.
11120     * @return The label of item.
11121     *
11122     * The return value is a pointer to the label associated to @p item when
11123     * it was created, with function elm_toolbar_item_append() or similar,
11124     * or later,
11125     * with function elm_toolbar_item_label_set. If no label
11126     * was passed as argument, it will return @c NULL.
11127     *
11128     * @see elm_toolbar_item_label_set() for more details.
11129     * @see elm_toolbar_item_append()
11130     *
11131     * @ingroup Toolbar
11132     */
11133    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11134
11135    /**
11136     * Set the label of item.
11137     *
11138     * @param item The item of toolbar.
11139     * @param text The label of item.
11140     *
11141     * The label to be displayed by the item.
11142     * Label will be placed at icons bottom (if set).
11143     *
11144     * If a label was passed as argument on item creation, with function
11145     * elm_toolbar_item_append() or similar, it will be already
11146     * displayed by the item.
11147     *
11148     * @see elm_toolbar_item_label_get()
11149     * @see elm_toolbar_item_append()
11150     *
11151     * @ingroup Toolbar
11152     */
11153    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11154
11155    /**
11156     * Return the data associated with a given toolbar widget item.
11157     *
11158     * @param item The toolbar widget item handle.
11159     * @return The data associated with @p item.
11160     *
11161     * @see elm_toolbar_item_data_set()
11162     *
11163     * @ingroup Toolbar
11164     */
11165    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11166
11167    /**
11168     * Set the data associated with a given toolbar widget item.
11169     *
11170     * @param item The toolbar widget item handle.
11171     * @param data The new data pointer to set to @p item.
11172     *
11173     * This sets new item data on @p item.
11174     *
11175     * @warning The old data pointer won't be touched by this function, so
11176     * the user had better to free that old data himself/herself.
11177     *
11178     * @ingroup Toolbar
11179     */
11180    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11181
11182    /**
11183     * Returns a pointer to a toolbar item by its label.
11184     *
11185     * @param obj The toolbar object.
11186     * @param label The label of the item to find.
11187     *
11188     * @return The pointer to the toolbar item matching @p label or @c NULL
11189     * on failure.
11190     *
11191     * @ingroup Toolbar
11192     */
11193    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11194
11195    /*
11196     * Get whether the @p item is selected or not.
11197     *
11198     * @param item The toolbar item.
11199     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11200     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11201     *
11202     * @see elm_toolbar_selected_item_set() for details.
11203     * @see elm_toolbar_item_selected_get()
11204     *
11205     * @ingroup Toolbar
11206     */
11207    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11208
11209    /**
11210     * Set the selected state of an item.
11211     *
11212     * @param item The toolbar item
11213     * @param selected The selected state
11214     *
11215     * This sets the selected state of the given item @p it.
11216     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11217     *
11218     * If a new item is selected the previosly selected will be unselected.
11219     * Previoulsy selected item can be get with function
11220     * elm_toolbar_selected_item_get().
11221     *
11222     * Selected items will be highlighted.
11223     *
11224     * @see elm_toolbar_item_selected_get()
11225     * @see elm_toolbar_selected_item_get()
11226     *
11227     * @ingroup Toolbar
11228     */
11229    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11230
11231    /**
11232     * Get the selected item.
11233     *
11234     * @param obj The toolbar object.
11235     * @return The selected toolbar item.
11236     *
11237     * The selected item can be unselected with function
11238     * elm_toolbar_item_selected_set().
11239     *
11240     * The selected item always will be highlighted on toolbar.
11241     *
11242     * @see elm_toolbar_selected_items_get()
11243     *
11244     * @ingroup Toolbar
11245     */
11246    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11247
11248    /**
11249     * Set the icon associated with @p item.
11250     *
11251     * @param obj The parent of this item.
11252     * @param item The toolbar item.
11253     * @param icon A string with icon name or the absolute path of an image file.
11254     *
11255     * Toolbar will load icon image from fdo or current theme.
11256     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11257     * If an absolute path is provided it will load it direct from a file.
11258     *
11259     * @see elm_toolbar_icon_order_lookup_set()
11260     * @see elm_toolbar_icon_order_lookup_get()
11261     *
11262     * @ingroup Toolbar
11263     */
11264    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11265
11266    /**
11267     * Get the string used to set the icon of @p item.
11268     *
11269     * @param item The toolbar item.
11270     * @return The string associated with the icon object.
11271     *
11272     * @see elm_toolbar_item_icon_set() for details.
11273     *
11274     * @ingroup Toolbar
11275     */
11276    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11277
11278    /**
11279     * Delete them item from the toolbar.
11280     *
11281     * @param item The item of toolbar to be deleted.
11282     *
11283     * @see elm_toolbar_item_append()
11284     * @see elm_toolbar_item_del_cb_set()
11285     *
11286     * @ingroup Toolbar
11287     */
11288    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11289
11290    /**
11291     * Set the function called when a toolbar item is freed.
11292     *
11293     * @param item The item to set the callback on.
11294     * @param func The function called.
11295     *
11296     * If there is a @p func, then it will be called prior item's memory release.
11297     * That will be called with the following arguments:
11298     * @li item's data;
11299     * @li item's Evas object;
11300     * @li item itself;
11301     *
11302     * This way, a data associated to a toolbar item could be properly freed.
11303     *
11304     * @ingroup Toolbar
11305     */
11306    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11307
11308    /**
11309     * Get a value whether toolbar item is disabled or not.
11310     *
11311     * @param item The item.
11312     * @return The disabled state.
11313     *
11314     * @see elm_toolbar_item_disabled_set() for more details.
11315     *
11316     * @ingroup Toolbar
11317     */
11318    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11319
11320    /**
11321     * Sets the disabled/enabled state of a toolbar item.
11322     *
11323     * @param item The item.
11324     * @param disabled The disabled state.
11325     *
11326     * A disabled item cannot be selected or unselected. It will also
11327     * change its appearance (generally greyed out). This sets the
11328     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11329     * enabled).
11330     *
11331     * @ingroup Toolbar
11332     */
11333    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11334
11335    /**
11336     * Set or unset item as a separator.
11337     *
11338     * @param item The toolbar item.
11339     * @param setting @c EINA_TRUE to set item @p item as separator or
11340     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11341     *
11342     * Items aren't set as separator by default.
11343     *
11344     * If set as separator it will display separator theme, so won't display
11345     * icons or label.
11346     *
11347     * @see elm_toolbar_item_separator_get()
11348     *
11349     * @ingroup Toolbar
11350     */
11351    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11352
11353    /**
11354     * Get a value whether item is a separator or not.
11355     *
11356     * @param item The toolbar item.
11357     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11358     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11359     *
11360     * @see elm_toolbar_item_separator_set() for details.
11361     *
11362     * @ingroup Toolbar
11363     */
11364    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11365
11366    /**
11367     * Set the shrink state of toolbar @p obj.
11368     *
11369     * @param obj The toolbar object.
11370     * @param shrink_mode Toolbar's items display behavior.
11371     *
11372     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11373     * but will enforce a minimun size so all the items will fit, won't scroll
11374     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11375     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11376     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11377     *
11378     * @ingroup Toolbar
11379     */
11380    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11381
11382    /**
11383     * Get the shrink mode of toolbar @p obj.
11384     *
11385     * @param obj The toolbar object.
11386     * @return Toolbar's items display behavior.
11387     *
11388     * @see elm_toolbar_mode_shrink_set() for details.
11389     *
11390     * @ingroup Toolbar
11391     */
11392    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11393
11394    /**
11395     * Enable/disable homogenous mode.
11396     *
11397     * @param obj The toolbar object
11398     * @param homogeneous Assume the items within the toolbar are of the
11399     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11400     *
11401     * This will enable the homogeneous mode where items are of the same size.
11402     * @see elm_toolbar_homogeneous_get()
11403     *
11404     * @ingroup Toolbar
11405     */
11406    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11407
11408    /**
11409     * Get whether the homogenous mode is enabled.
11410     *
11411     * @param obj The toolbar object.
11412     * @return Assume the items within the toolbar are of the same height
11413     * and width (EINA_TRUE = on, EINA_FALSE = off).
11414     *
11415     * @see elm_toolbar_homogeneous_set()
11416     *
11417     * @ingroup Toolbar
11418     */
11419    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11420
11421    /**
11422     * Enable/disable homogenous mode.
11423     *
11424     * @param obj The toolbar object
11425     * @param homogeneous Assume the items within the toolbar are of the
11426     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11427     *
11428     * This will enable the homogeneous mode where items are of the same size.
11429     * @see elm_toolbar_homogeneous_get()
11430     *
11431     * @deprecated use elm_toolbar_homogeneous_set() instead.
11432     *
11433     * @ingroup Toolbar
11434     */
11435    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11436
11437    /**
11438     * Get whether the homogenous mode is enabled.
11439     *
11440     * @param obj The toolbar object.
11441     * @return Assume the items within the toolbar are of the same height
11442     * and width (EINA_TRUE = on, EINA_FALSE = off).
11443     *
11444     * @see elm_toolbar_homogeneous_set()
11445     * @deprecated use elm_toolbar_homogeneous_get() instead.
11446     *
11447     * @ingroup Toolbar
11448     */
11449    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11450
11451    /**
11452     * Set the parent object of the toolbar items' menus.
11453     *
11454     * @param obj The toolbar object.
11455     * @param parent The parent of the menu objects.
11456     *
11457     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11458     *
11459     * For more details about setting the parent for toolbar menus, see
11460     * elm_menu_parent_set().
11461     *
11462     * @see elm_menu_parent_set() for details.
11463     * @see elm_toolbar_item_menu_set() for details.
11464     *
11465     * @ingroup Toolbar
11466     */
11467    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11468
11469    /**
11470     * Get the parent object of the toolbar items' menus.
11471     *
11472     * @param obj The toolbar object.
11473     * @return The parent of the menu objects.
11474     *
11475     * @see elm_toolbar_menu_parent_set() for details.
11476     *
11477     * @ingroup Toolbar
11478     */
11479    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11480
11481    /**
11482     * Set the alignment of the items.
11483     *
11484     * @param obj The toolbar object.
11485     * @param align The new alignment, a float between <tt> 0.0 </tt>
11486     * and <tt> 1.0 </tt>.
11487     *
11488     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11489     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11490     * items.
11491     *
11492     * Centered items by default.
11493     *
11494     * @see elm_toolbar_align_get()
11495     *
11496     * @ingroup Toolbar
11497     */
11498    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11499
11500    /**
11501     * Get the alignment of the items.
11502     *
11503     * @param obj The toolbar object.
11504     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11505     * <tt> 1.0 </tt>.
11506     *
11507     * @see elm_toolbar_align_set() for details.
11508     *
11509     * @ingroup Toolbar
11510     */
11511    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11512
11513    /**
11514     * Set whether the toolbar item opens a menu.
11515     *
11516     * @param item The toolbar item.
11517     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11518     *
11519     * A toolbar item can be set to be a menu, using this function.
11520     *
11521     * Once it is set to be a menu, it can be manipulated through the
11522     * menu-like function elm_toolbar_menu_parent_set() and the other
11523     * elm_menu functions, using the Evas_Object @c menu returned by
11524     * elm_toolbar_item_menu_get().
11525     *
11526     * So, items to be displayed in this item's menu should be added with
11527     * elm_menu_item_add().
11528     *
11529     * The following code exemplifies the most basic usage:
11530     * @code
11531     * tb = elm_toolbar_add(win)
11532     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11533     * elm_toolbar_item_menu_set(item, EINA_TRUE);
11534     * elm_toolbar_menu_parent_set(tb, win);
11535     * menu = elm_toolbar_item_menu_get(item);
11536     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11537     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11538     * NULL);
11539     * @endcode
11540     *
11541     * @see elm_toolbar_item_menu_get()
11542     *
11543     * @ingroup Toolbar
11544     */
11545    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11546
11547    /**
11548     * Get toolbar item's menu.
11549     *
11550     * @param item The toolbar item.
11551     * @return Item's menu object or @c NULL on failure.
11552     *
11553     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11554     * this function will set it.
11555     *
11556     * @see elm_toolbar_item_menu_set() for details.
11557     *
11558     * @ingroup Toolbar
11559     */
11560    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11561
11562    /**
11563     * Add a new state to @p item.
11564     *
11565     * @param item The item.
11566     * @param icon A string with icon name or the absolute path of an image file.
11567     * @param label The label of the new state.
11568     * @param func The function to call when the item is clicked when this
11569     * state is selected.
11570     * @param data The data to associate with the state.
11571     * @return The toolbar item state, or @c NULL upon failure.
11572     *
11573     * Toolbar will load icon image from fdo or current theme.
11574     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11575     * If an absolute path is provided it will load it direct from a file.
11576     *
11577     * States created with this function can be removed with
11578     * elm_toolbar_item_state_del().
11579     *
11580     * @see elm_toolbar_item_state_del()
11581     * @see elm_toolbar_item_state_sel()
11582     * @see elm_toolbar_item_state_get()
11583     *
11584     * @ingroup Toolbar
11585     */
11586    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);
11587
11588    /**
11589     * Delete a previoulsy added state to @p item.
11590     *
11591     * @param item The toolbar item.
11592     * @param state The state to be deleted.
11593     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11594     *
11595     * @see elm_toolbar_item_state_add()
11596     */
11597    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11598
11599    /**
11600     * Set @p state as the current state of @p it.
11601     *
11602     * @param it The item.
11603     * @param state The state to use.
11604     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11605     *
11606     * If @p state is @c NULL, it won't select any state and the default item's
11607     * icon and label will be used. It's the same behaviour than
11608     * elm_toolbar_item_state_unser().
11609     *
11610     * @see elm_toolbar_item_state_unset()
11611     *
11612     * @ingroup Toolbar
11613     */
11614    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11615
11616    /**
11617     * Unset the state of @p it.
11618     *
11619     * @param it The item.
11620     *
11621     * The default icon and label from this item will be displayed.
11622     *
11623     * @see elm_toolbar_item_state_set() for more details.
11624     *
11625     * @ingroup Toolbar
11626     */
11627    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11628
11629    /**
11630     * Get the current state of @p it.
11631     *
11632     * @param item The item.
11633     * @return The selected state or @c NULL if none is selected or on failure.
11634     *
11635     * @see elm_toolbar_item_state_set() for details.
11636     * @see elm_toolbar_item_state_unset()
11637     * @see elm_toolbar_item_state_add()
11638     *
11639     * @ingroup Toolbar
11640     */
11641    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11642
11643    /**
11644     * Get the state after selected state in toolbar's @p item.
11645     *
11646     * @param it The toolbar item to change state.
11647     * @return The state after current state, or @c NULL on failure.
11648     *
11649     * If last state is selected, this function will return first state.
11650     *
11651     * @see elm_toolbar_item_state_set()
11652     * @see elm_toolbar_item_state_add()
11653     *
11654     * @ingroup Toolbar
11655     */
11656    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11657
11658    /**
11659     * Get the state before selected state in toolbar's @p item.
11660     *
11661     * @param it The toolbar item to change state.
11662     * @return The state before current state, or @c NULL on failure.
11663     *
11664     * If first state is selected, this function will return last state.
11665     *
11666     * @see elm_toolbar_item_state_set()
11667     * @see elm_toolbar_item_state_add()
11668     *
11669     * @ingroup Toolbar
11670     */
11671    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11672
11673    /**
11674     * Set the text to be shown in a given toolbar item's tooltips.
11675     *
11676     * @param item Target item.
11677     * @param text The text to set in the content.
11678     *
11679     * Setup the text as tooltip to object. The item can have only one tooltip,
11680     * so any previous tooltip data - set with this function or
11681     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11682     *
11683     * @see elm_object_tooltip_text_set() for more details.
11684     *
11685     * @ingroup Toolbar
11686     */
11687    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11688
11689    /**
11690     * Set the content to be shown in the tooltip item.
11691     *
11692     * Setup the tooltip to item. The item can have only one tooltip,
11693     * so any previous tooltip data is removed. @p func(with @p data) will
11694     * be called every time that need show the tooltip and it should
11695     * return a valid Evas_Object. This object is then managed fully by
11696     * tooltip system and is deleted when the tooltip is gone.
11697     *
11698     * @param item the toolbar item being attached a tooltip.
11699     * @param func the function used to create the tooltip contents.
11700     * @param data what to provide to @a func as callback data/context.
11701     * @param del_cb called when data is not needed anymore, either when
11702     *        another callback replaces @a func, the tooltip is unset with
11703     *        elm_toolbar_item_tooltip_unset() or the owner @a item
11704     *        dies. This callback receives as the first parameter the
11705     *        given @a data, and @c event_info is the item.
11706     *
11707     * @see elm_object_tooltip_content_cb_set() for more details.
11708     *
11709     * @ingroup Toolbar
11710     */
11711    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);
11712
11713    /**
11714     * Unset tooltip from item.
11715     *
11716     * @param item toolbar item to remove previously set tooltip.
11717     *
11718     * Remove tooltip from item. The callback provided as del_cb to
11719     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11720     * it is not used anymore.
11721     *
11722     * @see elm_object_tooltip_unset() for more details.
11723     * @see elm_toolbar_item_tooltip_content_cb_set()
11724     *
11725     * @ingroup Toolbar
11726     */
11727    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11728
11729    /**
11730     * Sets a different style for this item tooltip.
11731     *
11732     * @note before you set a style you should define a tooltip with
11733     *       elm_toolbar_item_tooltip_content_cb_set() or
11734     *       elm_toolbar_item_tooltip_text_set()
11735     *
11736     * @param item toolbar item with tooltip already set.
11737     * @param style the theme style to use (default, transparent, ...)
11738     *
11739     * @see elm_object_tooltip_style_set() for more details.
11740     *
11741     * @ingroup Toolbar
11742     */
11743    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11744
11745    /**
11746     * Get the style for this item tooltip.
11747     *
11748     * @param item toolbar item with tooltip already set.
11749     * @return style the theme style in use, defaults to "default". If the
11750     *         object does not have a tooltip set, then NULL is returned.
11751     *
11752     * @see elm_object_tooltip_style_get() for more details.
11753     * @see elm_toolbar_item_tooltip_style_set()
11754     *
11755     * @ingroup Toolbar
11756     */
11757    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11758
11759    /**
11760     * Set the type of mouse pointer/cursor decoration to be shown,
11761     * when the mouse pointer is over the given toolbar widget item
11762     *
11763     * @param item toolbar item to customize cursor on
11764     * @param cursor the cursor type's name
11765     *
11766     * This function works analogously as elm_object_cursor_set(), but
11767     * here the cursor's changing area is restricted to the item's
11768     * area, and not the whole widget's. Note that that item cursors
11769     * have precedence over widget cursors, so that a mouse over an
11770     * item with custom cursor set will always show @b that cursor.
11771     *
11772     * If this function is called twice for an object, a previously set
11773     * cursor will be unset on the second call.
11774     *
11775     * @see elm_object_cursor_set()
11776     * @see elm_toolbar_item_cursor_get()
11777     * @see elm_toolbar_item_cursor_unset()
11778     *
11779     * @ingroup Toolbar
11780     */
11781    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
11782
11783    /*
11784     * Get the type of mouse pointer/cursor decoration set to be shown,
11785     * when the mouse pointer is over the given toolbar widget item
11786     *
11787     * @param item toolbar item with custom cursor set
11788     * @return the cursor type's name or @c NULL, if no custom cursors
11789     * were set to @p item (and on errors)
11790     *
11791     * @see elm_object_cursor_get()
11792     * @see elm_toolbar_item_cursor_set()
11793     * @see elm_toolbar_item_cursor_unset()
11794     *
11795     * @ingroup Toolbar
11796     */
11797    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11798
11799    /**
11800     * Unset any custom mouse pointer/cursor decoration set to be
11801     * shown, when the mouse pointer is over the given toolbar widget
11802     * item, thus making it show the @b default cursor again.
11803     *
11804     * @param item a toolbar item
11805     *
11806     * Use this call to undo any custom settings on this item's cursor
11807     * decoration, bringing it back to defaults (no custom style set).
11808     *
11809     * @see elm_object_cursor_unset()
11810     * @see elm_toolbar_item_cursor_set()
11811     *
11812     * @ingroup Toolbar
11813     */
11814    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11815
11816    /**
11817     * Set a different @b style for a given custom cursor set for a
11818     * toolbar item.
11819     *
11820     * @param item toolbar item with custom cursor set
11821     * @param style the <b>theme style</b> to use (e.g. @c "default",
11822     * @c "transparent", etc)
11823     *
11824     * This function only makes sense when one is using custom mouse
11825     * cursor decorations <b>defined in a theme file</b>, which can have,
11826     * given a cursor name/type, <b>alternate styles</b> on it. It
11827     * works analogously as elm_object_cursor_style_set(), but here
11828     * applyed only to toolbar item objects.
11829     *
11830     * @warning Before you set a cursor style you should have definen a
11831     *       custom cursor previously on the item, with
11832     *       elm_toolbar_item_cursor_set()
11833     *
11834     * @see elm_toolbar_item_cursor_engine_only_set()
11835     * @see elm_toolbar_item_cursor_style_get()
11836     *
11837     * @ingroup Toolbar
11838     */
11839    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11840
11841    /**
11842     * Get the current @b style set for a given toolbar item's custom
11843     * cursor
11844     *
11845     * @param item toolbar item with custom cursor set.
11846     * @return style the cursor style in use. If the object does not
11847     *         have a cursor set, then @c NULL is returned.
11848     *
11849     * @see elm_toolbar_item_cursor_style_set() for more details
11850     *
11851     * @ingroup Toolbar
11852     */
11853    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11854
11855    /**
11856     * Set if the (custom)cursor for a given toolbar item should be
11857     * searched in its theme, also, or should only rely on the
11858     * rendering engine.
11859     *
11860     * @param item item with custom (custom) cursor already set on
11861     * @param engine_only Use @c EINA_TRUE to have cursors looked for
11862     * only on those provided by the rendering engine, @c EINA_FALSE to
11863     * have them searched on the widget's theme, as well.
11864     *
11865     * @note This call is of use only if you've set a custom cursor
11866     * for toolbar items, with elm_toolbar_item_cursor_set().
11867     *
11868     * @note By default, cursors will only be looked for between those
11869     * provided by the rendering engine.
11870     *
11871     * @ingroup Toolbar
11872     */
11873    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11874
11875    /**
11876     * Get if the (custom) cursor for a given toolbar item is being
11877     * searched in its theme, also, or is only relying on the rendering
11878     * engine.
11879     *
11880     * @param item a toolbar item
11881     * @return @c EINA_TRUE, if cursors are being looked for only on
11882     * those provided by the rendering engine, @c EINA_FALSE if they
11883     * are being searched on the widget's theme, as well.
11884     *
11885     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
11886     *
11887     * @ingroup Toolbar
11888     */
11889    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11890
11891    /**
11892     * @}
11893     */
11894
11895    /* tooltip */
11896    EAPI double       elm_tooltip_delay_get(void);
11897    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
11898    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
11899    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
11900    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
11901    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);
11902    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11903    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11904    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11905    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
11906    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11907    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11908    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11909    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11910    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11911    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11912    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
11913    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
11914
11915    /* cursors */
11916    EAPI int          elm_cursor_engine_only_get(void);
11917    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
11918
11919    /**
11920     * @defgroup Menu Menu
11921     *
11922     * @image html img/widget/menu/preview-00.png
11923     * @image latex img/widget/menu/preview-00.eps
11924     *
11925     * A menu is a list of items displayed above its parent. When the menu is
11926     * showing its parent is darkened. Each item can have a sub-menu. The menu
11927     * object can be used to display a menu on a right click event, in a toolbar,
11928     * anywhere.
11929     *
11930     * Signals that you can add callbacks for are:
11931     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
11932     *             event_info is NULL.
11933     *
11934     * @see @ref tutorial_menu
11935     * @{
11936     */
11937    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
11938    /**
11939     * @brief Add a new menu to the parent
11940     *
11941     * @param parent The parent object.
11942     * @return The new object or NULL if it cannot be created.
11943     */
11944    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11945    /**
11946     * @brief Set the parent for the given menu widget
11947     *
11948     * @param obj The menu object.
11949     * @param parent The new parent.
11950     */
11951    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11952    /**
11953     * @brief Get the parent for the given menu widget
11954     *
11955     * @param obj The menu object.
11956     * @return The parent.
11957     *
11958     * @see elm_menu_parent_set()
11959     */
11960    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11961    /**
11962     * @brief Move the menu to a new position
11963     *
11964     * @param obj The menu object.
11965     * @param x The new position.
11966     * @param y The new position.
11967     *
11968     * Sets the top-left position of the menu to (@p x,@p y).
11969     *
11970     * @note @p x and @p y coordinates are relative to parent.
11971     */
11972    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
11973    /**
11974     * @brief Close a opened menu
11975     *
11976     * @param obj the menu object
11977     * @return void
11978     *
11979     * Hides the menu and all it's sub-menus.
11980     */
11981    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
11982    /**
11983     * @brief Returns a list of @p item's items.
11984     *
11985     * @param obj The menu object
11986     * @return An Eina_List* of @p item's items
11987     */
11988    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11989    /**
11990     * @brief Get the Evas_Object of an Elm_Menu_Item
11991     *
11992     * @param item The menu item object.
11993     * @return The edje object containing the swallowed content
11994     *
11995     * @warning Don't manipulate this object!
11996     */
11997    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
11998    /**
11999     * @brief Add an item at the end of the given menu widget
12000     *
12001     * @param obj The menu object.
12002     * @param parent The parent menu item (optional)
12003     * @param icon A icon display on the item. The icon will be destryed by the menu.
12004     * @param label The label of the item.
12005     * @param func Function called when the user select the item.
12006     * @param data Data sent by the callback.
12007     * @return Returns the new item.
12008     */
12009    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);
12010    /**
12011     * @brief Add an object swallowed in an item at the end of the given menu
12012     * widget
12013     *
12014     * @param obj The menu object.
12015     * @param parent The parent menu item (optional)
12016     * @param subobj The object to swallow
12017     * @param func Function called when the user select the item.
12018     * @param data Data sent by the callback.
12019     * @return Returns the new item.
12020     *
12021     * Add an evas object as an item to the menu.
12022     */
12023    EAPI Elm_Menu_Item     *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
12024    /**
12025     * @brief Set the label of a menu item
12026     *
12027     * @param item The menu item object.
12028     * @param label The label to set for @p item
12029     *
12030     * @warning Don't use this funcion on items created with
12031     * elm_menu_item_add_object() or elm_menu_item_separator_add().
12032     */
12033    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12034    /**
12035     * @brief Get the label of a menu item
12036     *
12037     * @param item The menu item object.
12038     * @return The label of @p item
12039     */
12040    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12041    /**
12042     * @brief Set the icon of a menu item to the standard icon with name @p icon
12043     *
12044     * @param item The menu item object.
12045     * @param icon The icon object to set for the content of @p item
12046     *
12047     * Once this icon is set, any previously set icon will be deleted.
12048     */
12049    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12050    /**
12051     * @brief Get the string representation from the icon of a menu item
12052     *
12053     * @param item The menu item object.
12054     * @return The string representation of @p item's icon or NULL
12055     *
12056     * @see elm_menu_item_object_icon_name_set()
12057     */
12058    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12059    /**
12060     * @deprecated Use elm_menu_item_object_icon_name_set()
12061     */
12062    EAPI void               elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2) EINA_DEPRECATED;
12063    /**
12064     * @deprecated Use elm_menu_item_object_icon_name_get()
12065     */
12066    EAPI const char        *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12067    /**
12068     * @brief Set the content object of a menu item
12069     *
12070     * @param item The menu item object
12071     * @param The content object or NULL
12072     * @return EINA_TRUE on success, else EINA_FALSE
12073     *
12074     * Use this function to change the object swallowed by a menu item, deleting
12075     * any previously swallowed object.
12076     */
12077    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12078    /**
12079     * @brief Get the content object of a menu item
12080     *
12081     * @param item The menu item object
12082     * @return The content object or NULL
12083     * @note If @p item was added with elm_menu_item_add_object, this
12084     * function will return the object passed, else it will return the
12085     * icon object.
12086     *
12087     * @see elm_menu_item_object_content_set()
12088     */
12089    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12090    /**
12091     * @deprecated Use elm_menu_item_object_content_get() instead.
12092     */
12093    EAPI Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12094    /**
12095     * @brief Set the selected state of @p item.
12096     *
12097     * @param item The menu item object.
12098     * @param selected The selected/unselected state of the item
12099     */
12100    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12101    /**
12102     * @brief Get the selected state of @p item.
12103     *
12104     * @param item The menu item object.
12105     * @return The selected/unselected state of the item
12106     *
12107     * @see elm_menu_item_selected_set()
12108     */
12109    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12110    /**
12111     * @brief Set the disabled state of @p item.
12112     *
12113     * @param item The menu item object.
12114     * @param disabled The enabled/disabled state of the item
12115     */
12116    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12117    /**
12118     * @brief Get the disabled state of @p item.
12119     *
12120     * @param item The menu item object.
12121     * @return The enabled/disabled state of the item
12122     *
12123     * @see elm_menu_item_disabled_set()
12124     */
12125    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12126    /**
12127     * @brief Add a separator item to menu @p obj under @p parent.
12128     *
12129     * @param obj The menu object
12130     * @param parent The item to add the separator under
12131     * @return The created item or NULL on failure
12132     *
12133     * This is item is a @ref Separator.
12134     */
12135    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12136    /**
12137     * @brief Returns whether @p item is a separator.
12138     *
12139     * @param item The item to check
12140     * @return If true, @p item is a separator
12141     *
12142     * @see elm_menu_item_separator_add()
12143     */
12144    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12145    /**
12146     * @brief Deletes an item from the menu.
12147     *
12148     * @param item The item to delete.
12149     *
12150     * @see elm_menu_item_add()
12151     */
12152    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12153    /**
12154     * @brief Set the function called when a menu item is deleted.
12155     *
12156     * @param item The item to set the callback on
12157     * @param func The function called
12158     *
12159     * @see elm_menu_item_add()
12160     * @see elm_menu_item_del()
12161     */
12162    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12163    /**
12164     * @brief Returns the data associated with menu item @p item.
12165     *
12166     * @param item The item
12167     * @return The data associated with @p item or NULL if none was set.
12168     *
12169     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12170     */
12171    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12172    /**
12173     * @brief Sets the data to be associated with menu item @p item.
12174     *
12175     * @param item The item
12176     * @param data The data to be associated with @p item
12177     */
12178    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12179    /**
12180     * @brief Returns a list of @p item's subitems.
12181     *
12182     * @param item The item
12183     * @return An Eina_List* of @p item's subitems
12184     *
12185     * @see elm_menu_add()
12186     */
12187    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12188    /**
12189     * @brief Get the position of a menu item
12190     *
12191     * @param item The menu item
12192     * @return The item's index
12193     *
12194     * This function returns the index position of a menu item in a menu.
12195     * For a sub-menu, this number is relative to the first item in the sub-menu.
12196     *
12197     * @note Index values begin with 0
12198     */
12199    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12200    /**
12201     * @brief @brief Return a menu item's owner menu
12202     *
12203     * @param item The menu item
12204     * @return The menu object owning @p item, or NULL on failure
12205     *
12206     * Use this function to get the menu object owning an item.
12207     */
12208    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12209    /**
12210     * @brief Get the selected item in the menu
12211     *
12212     * @param obj The menu object
12213     * @return The selected item, or NULL if none
12214     *
12215     * @see elm_menu_item_selected_get()
12216     * @see elm_menu_item_selected_set()
12217     */
12218    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12219    /**
12220     * @brief Get the last item in the menu
12221     *
12222     * @param obj The menu object
12223     * @return The last item, or NULL if none
12224     */
12225    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12226    /**
12227     * @brief Get the first item in the menu
12228     *
12229     * @param obj The menu object
12230     * @return The first item, or NULL if none
12231     */
12232    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12233    /**
12234     * @brief Get the next item in the menu.
12235     *
12236     * @param item The menu item object.
12237     * @return The item after it, or NULL if none
12238     */
12239    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12240    /**
12241     * @brief Get the previous item in the menu.
12242     *
12243     * @param item The menu item object.
12244     * @return The item before it, or NULL if none
12245     */
12246    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12247    /**
12248     * @}
12249     */
12250
12251    /**
12252     * @defgroup List List
12253     * @ingroup Elementary
12254     *
12255     * @image html img/widget/list/preview-00.png
12256     * @image latex img/widget/list/preview-00.eps width=\textwidth
12257     *
12258     * @image html img/list.png
12259     * @image latex img/list.eps width=\textwidth
12260     *
12261     * A list widget is a container whose children are displayed vertically or
12262     * horizontally, in order, and can be selected.
12263     * The list can accept only one or multiple items selection. Also has many
12264     * modes of items displaying.
12265     *
12266     * A list is a very simple type of list widget.  For more robust
12267     * lists, @ref Genlist should probably be used.
12268     *
12269     * Smart callbacks one can listen to:
12270     * - @c "activated" - The user has double-clicked or pressed
12271     *   (enter|return|spacebar) on an item. The @c event_info parameter
12272     *   is the item that was activated.
12273     * - @c "clicked,double" - The user has double-clicked an item.
12274     *   The @c event_info parameter is the item that was double-clicked.
12275     * - "selected" - when the user selected an item
12276     * - "unselected" - when the user unselected an item
12277     * - "longpressed" - an item in the list is long-pressed
12278     * - "scroll,edge,top" - the list is scrolled until the top edge
12279     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12280     * - "scroll,edge,left" - the list is scrolled until the left edge
12281     * - "scroll,edge,right" - the list is scrolled until the right edge
12282     *
12283     * Available styles for it:
12284     * - @c "default"
12285     *
12286     * List of examples:
12287     * @li @ref list_example_01
12288     * @li @ref list_example_02
12289     * @li @ref list_example_03
12290     */
12291
12292    /**
12293     * @addtogroup List
12294     * @{
12295     */
12296
12297    /**
12298     * @enum _Elm_List_Mode
12299     * @typedef Elm_List_Mode
12300     *
12301     * Set list's resize behavior, transverse axis scroll and
12302     * items cropping. See each mode's description for more details.
12303     *
12304     * @note Default value is #ELM_LIST_SCROLL.
12305     *
12306     * Values <b> don't </b> work as bitmask, only one can be choosen.
12307     *
12308     * @see elm_list_mode_set()
12309     * @see elm_list_mode_get()
12310     *
12311     * @ingroup List
12312     */
12313    typedef enum _Elm_List_Mode
12314      {
12315         ELM_LIST_COMPRESS = 0, /**< Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. */
12316         ELM_LIST_SCROLL, /**< Default value. Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction (large items will get cropped). */
12317         ELM_LIST_LIMIT, /**< Set a minimun size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a minimum size hint will be set for its transverse axis, so that the @b largest item in that direction fits well. Can have effects bounded by setting the list object's maximum size hints. */
12318         ELM_LIST_EXPAND, /**< Besides setting a minimum size on the transverse axis, just like the previous mode, will set a minimum size on the longitudinal axis too, trying to reserve space to all its children to be visible at a time. Can have effects bounded by setting the list object's maximum size hints. */
12319         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12320      } Elm_List_Mode;
12321
12322    typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item. Can be created with elm_list_item_append(), elm_list_item_prepend() and functions to add items in relative positions, like elm_list_item_insert_before(), and deleted with elm_list_item_del().  */
12323
12324    /**
12325     * Add a new list widget to the given parent Elementary
12326     * (container) object.
12327     *
12328     * @param parent The parent object.
12329     * @return a new list widget handle or @c NULL, on errors.
12330     *
12331     * This function inserts a new list widget on the canvas.
12332     *
12333     * @ingroup List
12334     */
12335    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12336
12337    /**
12338     * Starts the list.
12339     *
12340     * @param obj The list object
12341     *
12342     * @note Call before running show() on the list object.
12343     * @warning If not called, it won't display the list properly.
12344     *
12345     * @code
12346     * li = elm_list_add(win);
12347     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12348     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12349     * elm_list_go(li);
12350     * evas_object_show(li);
12351     * @endcode
12352     *
12353     * @ingroup List
12354     */
12355    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12356
12357    /**
12358     * Enable or disable multiple items selection on the list object.
12359     *
12360     * @param obj The list object
12361     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12362     * disable it.
12363     *
12364     * Disabled by default. If disabled, the user can select a single item of
12365     * the list each time. Selected items are highlighted on list.
12366     * If enabled, many items can be selected.
12367     *
12368     * If a selected item is selected again, it will be unselected.
12369     *
12370     * @see elm_list_multi_select_get()
12371     *
12372     * @ingroup List
12373     */
12374    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12375
12376    /**
12377     * Get a value whether multiple items selection is enabled or not.
12378     *
12379     * @see elm_list_multi_select_set() for details.
12380     *
12381     * @param obj The list object.
12382     * @return @c EINA_TRUE means multiple items selection is enabled.
12383     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12384     * @c EINA_FALSE is returned.
12385     *
12386     * @ingroup List
12387     */
12388    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12389
12390    /**
12391     * Set which mode to use for the list object.
12392     *
12393     * @param obj The list object
12394     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12395     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12396     *
12397     * Set list's resize behavior, transverse axis scroll and
12398     * items cropping. See each mode's description for more details.
12399     *
12400     * @note Default value is #ELM_LIST_SCROLL.
12401     *
12402     * Only one can be set, if a previous one was set, it will be changed
12403     * by the new mode set. Bitmask won't work as well.
12404     *
12405     * @see elm_list_mode_get()
12406     *
12407     * @ingroup List
12408     */
12409    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12410
12411    /**
12412     * Get the mode the list is at.
12413     *
12414     * @param obj The list object
12415     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12416     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12417     *
12418     * @note see elm_list_mode_set() for more information.
12419     *
12420     * @ingroup List
12421     */
12422    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12423
12424    /**
12425     * Enable or disable horizontal mode on the list object.
12426     *
12427     * @param obj The list object.
12428     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12429     * disable it, i.e., to enable vertical mode.
12430     *
12431     * @note Vertical mode is set by default.
12432     *
12433     * On horizontal mode items are displayed on list from left to right,
12434     * instead of from top to bottom. Also, the list will scroll horizontally.
12435     * Each item will presents left icon on top and right icon, or end, at
12436     * the bottom.
12437     *
12438     * @see elm_list_horizontal_get()
12439     *
12440     * @ingroup List
12441     */
12442    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12443
12444    /**
12445     * Get a value whether horizontal mode is enabled or not.
12446     *
12447     * @param obj The list object.
12448     * @return @c EINA_TRUE means horizontal mode selection is enabled.
12449     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12450     * @c EINA_FALSE is returned.
12451     *
12452     * @see elm_list_horizontal_set() for details.
12453     *
12454     * @ingroup List
12455     */
12456    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12457
12458    /**
12459     * Enable or disable always select mode on the list object.
12460     *
12461     * @param obj The list object
12462     * @param always_select @c EINA_TRUE to enable always select mode or
12463     * @c EINA_FALSE to disable it.
12464     *
12465     * @note Always select mode is disabled by default.
12466     *
12467     * Default behavior of list items is to only call its callback function
12468     * the first time it's pressed, i.e., when it is selected. If a selected
12469     * item is pressed again, and multi-select is disabled, it won't call
12470     * this function (if multi-select is enabled it will unselect the item).
12471     *
12472     * If always select is enabled, it will call the callback function
12473     * everytime a item is pressed, so it will call when the item is selected,
12474     * and again when a selected item is pressed.
12475     *
12476     * @see elm_list_always_select_mode_get()
12477     * @see elm_list_multi_select_set()
12478     *
12479     * @ingroup List
12480     */
12481    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12482
12483    /**
12484     * Get a value whether always select mode is enabled or not, meaning that
12485     * an item will always call its callback function, even if already selected.
12486     *
12487     * @param obj The list object
12488     * @return @c EINA_TRUE means horizontal mode selection is enabled.
12489     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12490     * @c EINA_FALSE is returned.
12491     *
12492     * @see elm_list_always_select_mode_set() for details.
12493     *
12494     * @ingroup List
12495     */
12496    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12497
12498    /**
12499     * Set bouncing behaviour when the scrolled content reaches an edge.
12500     *
12501     * Tell the internal scroller object whether it should bounce or not
12502     * when it reaches the respective edges for each axis.
12503     *
12504     * @param obj The list object
12505     * @param h_bounce Whether to bounce or not in the horizontal axis.
12506     * @param v_bounce Whether to bounce or not in the vertical axis.
12507     *
12508     * @see elm_scroller_bounce_set()
12509     *
12510     * @ingroup List
12511     */
12512    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12513
12514    /**
12515     * Get the bouncing behaviour of the internal scroller.
12516     *
12517     * Get whether the internal scroller should bounce when the edge of each
12518     * axis is reached scrolling.
12519     *
12520     * @param obj The list object.
12521     * @param h_bounce Pointer where to store the bounce state of the horizontal
12522     * axis.
12523     * @param v_bounce Pointer where to store the bounce state of the vertical
12524     * axis.
12525     *
12526     * @see elm_scroller_bounce_get()
12527     * @see elm_list_bounce_set()
12528     *
12529     * @ingroup List
12530     */
12531    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12532
12533    /**
12534     * Set the scrollbar policy.
12535     *
12536     * @param obj The list object
12537     * @param policy_h Horizontal scrollbar policy.
12538     * @param policy_v Vertical scrollbar policy.
12539     *
12540     * This sets the scrollbar visibility policy for the given scroller.
12541     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12542     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12543     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12544     * This applies respectively for the horizontal and vertical scrollbars.
12545     *
12546     * The both are disabled by default, i.e., are set to
12547     * #ELM_SCROLLER_POLICY_OFF.
12548     *
12549     * @ingroup List
12550     */
12551    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12552
12553    /**
12554     * Get the scrollbar policy.
12555     *
12556     * @see elm_list_scroller_policy_get() for details.
12557     *
12558     * @param obj The list object.
12559     * @param policy_h Pointer where to store horizontal scrollbar policy.
12560     * @param policy_v Pointer where to store vertical scrollbar policy.
12561     *
12562     * @ingroup List
12563     */
12564    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);
12565
12566    /**
12567     * Append a new item to the list object.
12568     *
12569     * @param obj The list object.
12570     * @param label The label of the list item.
12571     * @param icon The icon object to use for the left side of the item. An
12572     * icon can be any Evas object, but usually it is an icon created
12573     * with elm_icon_add().
12574     * @param end The icon object to use for the right side of the item. An
12575     * icon can be any Evas object.
12576     * @param func The function to call when the item is clicked.
12577     * @param data The data to associate with the item for related callbacks.
12578     *
12579     * @return The created item or @c NULL upon failure.
12580     *
12581     * A new item will be created and appended to the list, i.e., will
12582     * be set as @b last item.
12583     *
12584     * Items created with this method can be deleted with
12585     * elm_list_item_del().
12586     *
12587     * Associated @p data can be properly freed when item is deleted if a
12588     * callback function is set with elm_list_item_del_cb_set().
12589     *
12590     * If a function is passed as argument, it will be called everytime this item
12591     * is selected, i.e., the user clicks over an unselected item.
12592     * If always select is enabled it will call this function every time
12593     * user clicks over an item (already selected or not).
12594     * If such function isn't needed, just passing
12595     * @c NULL as @p func is enough. The same should be done for @p data.
12596     *
12597     * Simple example (with no function callback or data associated):
12598     * @code
12599     * li = elm_list_add(win);
12600     * ic = elm_icon_add(win);
12601     * elm_icon_file_set(ic, "path/to/image", NULL);
12602     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12603     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12604     * elm_list_go(li);
12605     * evas_object_show(li);
12606     * @endcode
12607     *
12608     * @see elm_list_always_select_mode_set()
12609     * @see elm_list_item_del()
12610     * @see elm_list_item_del_cb_set()
12611     * @see elm_list_clear()
12612     * @see elm_icon_add()
12613     *
12614     * @ingroup List
12615     */
12616    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);
12617
12618    /**
12619     * Prepend a new item to the list object.
12620     *
12621     * @param obj The list object.
12622     * @param label The label of the list item.
12623     * @param icon The icon object to use for the left side of the item. An
12624     * icon can be any Evas object, but usually it is an icon created
12625     * with elm_icon_add().
12626     * @param end The icon object to use for the right side of the item. An
12627     * icon can be any Evas object.
12628     * @param func The function to call when the item is clicked.
12629     * @param data The data to associate with the item for related callbacks.
12630     *
12631     * @return The created item or @c NULL upon failure.
12632     *
12633     * A new item will be created and prepended to the list, i.e., will
12634     * be set as @b first item.
12635     *
12636     * Items created with this method can be deleted with
12637     * elm_list_item_del().
12638     *
12639     * Associated @p data can be properly freed when item is deleted if a
12640     * callback function is set with elm_list_item_del_cb_set().
12641     *
12642     * If a function is passed as argument, it will be called everytime this item
12643     * is selected, i.e., the user clicks over an unselected item.
12644     * If always select is enabled it will call this function every time
12645     * user clicks over an item (already selected or not).
12646     * If such function isn't needed, just passing
12647     * @c NULL as @p func is enough. The same should be done for @p data.
12648     *
12649     * @see elm_list_item_append() for a simple code example.
12650     * @see elm_list_always_select_mode_set()
12651     * @see elm_list_item_del()
12652     * @see elm_list_item_del_cb_set()
12653     * @see elm_list_clear()
12654     * @see elm_icon_add()
12655     *
12656     * @ingroup List
12657     */
12658    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);
12659
12660    /**
12661     * Insert a new item into the list object before item @p before.
12662     *
12663     * @param obj The list object.
12664     * @param before The list item to insert before.
12665     * @param label The label of the list item.
12666     * @param icon The icon object to use for the left side of the item. An
12667     * icon can be any Evas object, but usually it is an icon created
12668     * with elm_icon_add().
12669     * @param end The icon object to use for the right side of the item. An
12670     * icon can be any Evas object.
12671     * @param func The function to call when the item is clicked.
12672     * @param data The data to associate with the item for related callbacks.
12673     *
12674     * @return The created item or @c NULL upon failure.
12675     *
12676     * A new item will be created and added to the list. Its position in
12677     * this list will be just before item @p before.
12678     *
12679     * Items created with this method can be deleted with
12680     * elm_list_item_del().
12681     *
12682     * Associated @p data can be properly freed when item is deleted if a
12683     * callback function is set with elm_list_item_del_cb_set().
12684     *
12685     * If a function is passed as argument, it will be called everytime this item
12686     * is selected, i.e., the user clicks over an unselected item.
12687     * If always select is enabled it will call this function every time
12688     * user clicks over an item (already selected or not).
12689     * If such function isn't needed, just passing
12690     * @c NULL as @p func is enough. The same should be done for @p data.
12691     *
12692     * @see elm_list_item_append() for a simple code example.
12693     * @see elm_list_always_select_mode_set()
12694     * @see elm_list_item_del()
12695     * @see elm_list_item_del_cb_set()
12696     * @see elm_list_clear()
12697     * @see elm_icon_add()
12698     *
12699     * @ingroup List
12700     */
12701    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);
12702
12703    /**
12704     * Insert a new item into the list object after item @p after.
12705     *
12706     * @param obj The list object.
12707     * @param after The list item to insert after.
12708     * @param label The label of the list item.
12709     * @param icon The icon object to use for the left side of the item. An
12710     * icon can be any Evas object, but usually it is an icon created
12711     * with elm_icon_add().
12712     * @param end The icon object to use for the right side of the item. An
12713     * icon can be any Evas object.
12714     * @param func The function to call when the item is clicked.
12715     * @param data The data to associate with the item for related callbacks.
12716     *
12717     * @return The created item or @c NULL upon failure.
12718     *
12719     * A new item will be created and added to the list. Its position in
12720     * this list will be just after item @p after.
12721     *
12722     * Items created with this method can be deleted with
12723     * elm_list_item_del().
12724     *
12725     * Associated @p data can be properly freed when item is deleted if a
12726     * callback function is set with elm_list_item_del_cb_set().
12727     *
12728     * If a function is passed as argument, it will be called everytime this item
12729     * is selected, i.e., the user clicks over an unselected item.
12730     * If always select is enabled it will call this function every time
12731     * user clicks over an item (already selected or not).
12732     * If such function isn't needed, just passing
12733     * @c NULL as @p func is enough. The same should be done for @p data.
12734     *
12735     * @see elm_list_item_append() for a simple code example.
12736     * @see elm_list_always_select_mode_set()
12737     * @see elm_list_item_del()
12738     * @see elm_list_item_del_cb_set()
12739     * @see elm_list_clear()
12740     * @see elm_icon_add()
12741     *
12742     * @ingroup List
12743     */
12744    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);
12745
12746    /**
12747     * Insert a new item into the sorted list object.
12748     *
12749     * @param obj The list object.
12750     * @param label The label of the list item.
12751     * @param icon The icon object to use for the left side of the item. An
12752     * icon can be any Evas object, but usually it is an icon created
12753     * with elm_icon_add().
12754     * @param end The icon object to use for the right side of the item. An
12755     * icon can be any Evas object.
12756     * @param func The function to call when the item is clicked.
12757     * @param data The data to associate with the item for related callbacks.
12758     * @param cmp_func The comparing function to be used to sort list
12759     * items <b>by #Elm_List_Item item handles</b>. This function will
12760     * receive two items and compare them, returning a non-negative integer
12761     * if the second item should be place after the first, or negative value
12762     * if should be placed before.
12763     *
12764     * @return The created item or @c NULL upon failure.
12765     *
12766     * @note This function inserts values into a list object assuming it was
12767     * sorted and the result will be sorted.
12768     *
12769     * A new item will be created and added to the list. Its position in
12770     * this list will be found comparing the new item with previously inserted
12771     * items using function @p cmp_func.
12772     *
12773     * Items created with this method can be deleted with
12774     * elm_list_item_del().
12775     *
12776     * Associated @p data can be properly freed when item is deleted if a
12777     * callback function is set with elm_list_item_del_cb_set().
12778     *
12779     * If a function is passed as argument, it will be called everytime this item
12780     * is selected, i.e., the user clicks over an unselected item.
12781     * If always select is enabled it will call this function every time
12782     * user clicks over an item (already selected or not).
12783     * If such function isn't needed, just passing
12784     * @c NULL as @p func is enough. The same should be done for @p data.
12785     *
12786     * @see elm_list_item_append() for a simple code example.
12787     * @see elm_list_always_select_mode_set()
12788     * @see elm_list_item_del()
12789     * @see elm_list_item_del_cb_set()
12790     * @see elm_list_clear()
12791     * @see elm_icon_add()
12792     *
12793     * @ingroup List
12794     */
12795    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);
12796
12797    /**
12798     * Remove all list's items.
12799     *
12800     * @param obj The list object
12801     *
12802     * @see elm_list_item_del()
12803     * @see elm_list_item_append()
12804     *
12805     * @ingroup List
12806     */
12807    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12808
12809    /**
12810     * Get a list of all the list items.
12811     *
12812     * @param obj The list object
12813     * @return An @c Eina_List of list items, #Elm_List_Item,
12814     * or @c NULL on failure.
12815     *
12816     * @see elm_list_item_append()
12817     * @see elm_list_item_del()
12818     * @see elm_list_clear()
12819     *
12820     * @ingroup List
12821     */
12822    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12823
12824    /**
12825     * Get the selected item.
12826     *
12827     * @param obj The list object.
12828     * @return The selected list item.
12829     *
12830     * The selected item can be unselected with function
12831     * elm_list_item_selected_set().
12832     *
12833     * The selected item always will be highlighted on list.
12834     *
12835     * @see elm_list_selected_items_get()
12836     *
12837     * @ingroup List
12838     */
12839    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12840
12841    /**
12842     * Return a list of the currently selected list items.
12843     *
12844     * @param obj The list object.
12845     * @return An @c Eina_List of list items, #Elm_List_Item,
12846     * or @c NULL on failure.
12847     *
12848     * Multiple items can be selected if multi select is enabled. It can be
12849     * done with elm_list_multi_select_set().
12850     *
12851     * @see elm_list_selected_item_get()
12852     * @see elm_list_multi_select_set()
12853     *
12854     * @ingroup List
12855     */
12856    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12857
12858    /**
12859     * Set the selected state of an item.
12860     *
12861     * @param item The list item
12862     * @param selected The selected state
12863     *
12864     * This sets the selected state of the given item @p it.
12865     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
12866     *
12867     * If a new item is selected the previosly selected will be unselected,
12868     * unless multiple selection is enabled with elm_list_multi_select_set().
12869     * Previoulsy selected item can be get with function
12870     * elm_list_selected_item_get().
12871     *
12872     * Selected items will be highlighted.
12873     *
12874     * @see elm_list_item_selected_get()
12875     * @see elm_list_selected_item_get()
12876     * @see elm_list_multi_select_set()
12877     *
12878     * @ingroup List
12879     */
12880    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12881
12882    /*
12883     * Get whether the @p item is selected or not.
12884     *
12885     * @param item The list item.
12886     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
12887     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
12888     *
12889     * @see elm_list_selected_item_set() for details.
12890     * @see elm_list_item_selected_get()
12891     *
12892     * @ingroup List
12893     */
12894    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12895
12896    /**
12897     * Set or unset item as a separator.
12898     *
12899     * @param it The list item.
12900     * @param setting @c EINA_TRUE to set item @p it as separator or
12901     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
12902     *
12903     * Items aren't set as separator by default.
12904     *
12905     * If set as separator it will display separator theme, so won't display
12906     * icons or label.
12907     *
12908     * @see elm_list_item_separator_get()
12909     *
12910     * @ingroup List
12911     */
12912    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
12913
12914    /**
12915     * Get a value whether item is a separator or not.
12916     *
12917     * @see elm_list_item_separator_set() for details.
12918     *
12919     * @param it The list item.
12920     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
12921     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
12922     *
12923     * @ingroup List
12924     */
12925    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12926
12927    /**
12928     * Show @p item in the list view.
12929     *
12930     * @param item The list item to be shown.
12931     *
12932     * It won't animate list until item is visible. If such behavior is wanted,
12933     * use elm_list_bring_in() intead.
12934     *
12935     * @ingroup List
12936     */
12937    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12938
12939    /**
12940     * Bring in the given item to list view.
12941     *
12942     * @param item The item.
12943     *
12944     * This causes list to jump to the given item @p item and show it
12945     * (by scrolling), if it is not fully visible.
12946     *
12947     * This may use animation to do so and take a period of time.
12948     *
12949     * If animation isn't wanted, elm_list_item_show() can be used.
12950     *
12951     * @ingroup List
12952     */
12953    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12954
12955    /**
12956     * Delete them item from the list.
12957     *
12958     * @param item The item of list to be deleted.
12959     *
12960     * If deleting all list items is required, elm_list_clear()
12961     * should be used instead of getting items list and deleting each one.
12962     *
12963     * @see elm_list_clear()
12964     * @see elm_list_item_append()
12965     * @see elm_list_item_del_cb_set()
12966     *
12967     * @ingroup List
12968     */
12969    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12970
12971    /**
12972     * Set the function called when a list item is freed.
12973     *
12974     * @param item The item to set the callback on
12975     * @param func The function called
12976     *
12977     * If there is a @p func, then it will be called prior item's memory release.
12978     * That will be called with the following arguments:
12979     * @li item's data;
12980     * @li item's Evas object;
12981     * @li item itself;
12982     *
12983     * This way, a data associated to a list item could be properly freed.
12984     *
12985     * @ingroup List
12986     */
12987    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12988
12989    /**
12990     * Get the data associated to the item.
12991     *
12992     * @param item The list item
12993     * @return The data associated to @p item
12994     *
12995     * The return value is a pointer to data associated to @p item when it was
12996     * created, with function elm_list_item_append() or similar. If no data
12997     * was passed as argument, it will return @c NULL.
12998     *
12999     * @see elm_list_item_append()
13000     *
13001     * @ingroup List
13002     */
13003    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13004
13005    /**
13006     * Get the left side icon associated to the item.
13007     *
13008     * @param item The list item
13009     * @return The left side icon associated to @p item
13010     *
13011     * The return value is a pointer to the icon associated to @p item when
13012     * it was
13013     * created, with function elm_list_item_append() or similar, or later
13014     * with function elm_list_item_icon_set(). If no icon
13015     * was passed as argument, it will return @c NULL.
13016     *
13017     * @see elm_list_item_append()
13018     * @see elm_list_item_icon_set()
13019     *
13020     * @ingroup List
13021     */
13022    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13023
13024    /**
13025     * Set the left side icon associated to the item.
13026     *
13027     * @param item The list item
13028     * @param icon The left side icon object to associate with @p item
13029     *
13030     * The icon object to use at left side of the item. An
13031     * icon can be any Evas object, but usually it is an icon created
13032     * with elm_icon_add().
13033     *
13034     * Once the icon object is set, a previously set one will be deleted.
13035     * @warning Setting the same icon for two items will cause the icon to
13036     * dissapear from the first item.
13037     *
13038     * If an icon was passed as argument on item creation, with function
13039     * elm_list_item_append() or similar, it will be already
13040     * associated to the item.
13041     *
13042     * @see elm_list_item_append()
13043     * @see elm_list_item_icon_get()
13044     *
13045     * @ingroup List
13046     */
13047    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13048
13049    /**
13050     * Get the right side icon associated to the item.
13051     *
13052     * @param item The list item
13053     * @return The right side icon associated to @p item
13054     *
13055     * The return value is a pointer to the icon associated to @p item when
13056     * it was
13057     * created, with function elm_list_item_append() or similar, or later
13058     * with function elm_list_item_icon_set(). If no icon
13059     * was passed as argument, it will return @c NULL.
13060     *
13061     * @see elm_list_item_append()
13062     * @see elm_list_item_icon_set()
13063     *
13064     * @ingroup List
13065     */
13066    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13067
13068    /**
13069     * Set the right side icon associated to the item.
13070     *
13071     * @param item The list item
13072     * @param end The right side icon object to associate with @p item
13073     *
13074     * The icon object to use at right side of the item. An
13075     * icon can be any Evas object, but usually it is an icon created
13076     * with elm_icon_add().
13077     *
13078     * Once the icon object is set, a previously set one will be deleted.
13079     * @warning Setting the same icon for two items will cause the icon to
13080     * dissapear from the first item.
13081     *
13082     * If an icon was passed as argument on item creation, with function
13083     * elm_list_item_append() or similar, it will be already
13084     * associated to the item.
13085     *
13086     * @see elm_list_item_append()
13087     * @see elm_list_item_end_get()
13088     *
13089     * @ingroup List
13090     */
13091    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13092
13093    /**
13094     * Gets the base object of the item.
13095     *
13096     * @param item The list item
13097     * @return The base object associated with @p item
13098     *
13099     * Base object is the @c Evas_Object that represents that item.
13100     *
13101     * @ingroup List
13102     */
13103    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13104
13105    /**
13106     * Get the label of item.
13107     *
13108     * @param item The item of list.
13109     * @return The label of item.
13110     *
13111     * The return value is a pointer to the label associated to @p item when
13112     * it was created, with function elm_list_item_append(), or later
13113     * with function elm_list_item_label_set. If no label
13114     * was passed as argument, it will return @c NULL.
13115     *
13116     * @see elm_list_item_label_set() for more details.
13117     * @see elm_list_item_append()
13118     *
13119     * @ingroup List
13120     */
13121    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13122
13123    /**
13124     * Set the label of item.
13125     *
13126     * @param item The item of list.
13127     * @param text The label of item.
13128     *
13129     * The label to be displayed by the item.
13130     * Label will be placed between left and right side icons (if set).
13131     *
13132     * If a label was passed as argument on item creation, with function
13133     * elm_list_item_append() or similar, it will be already
13134     * displayed by the item.
13135     *
13136     * @see elm_list_item_label_get()
13137     * @see elm_list_item_append()
13138     *
13139     * @ingroup List
13140     */
13141    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13142
13143
13144    /**
13145     * Get the item before @p it in list.
13146     *
13147     * @param it The list item.
13148     * @return The item before @p it, or @c NULL if none or on failure.
13149     *
13150     * @note If it is the first item, @c NULL will be returned.
13151     *
13152     * @see elm_list_item_append()
13153     * @see elm_list_items_get()
13154     *
13155     * @ingroup List
13156     */
13157    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13158
13159    /**
13160     * Get the item after @p it in list.
13161     *
13162     * @param it The list item.
13163     * @return The item after @p it, or @c NULL if none or on failure.
13164     *
13165     * @note If it is the last item, @c NULL will be returned.
13166     *
13167     * @see elm_list_item_append()
13168     * @see elm_list_items_get()
13169     *
13170     * @ingroup List
13171     */
13172    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13173
13174    /**
13175     * Sets the disabled/enabled state of a list item.
13176     *
13177     * @param it The item.
13178     * @param disabled The disabled state.
13179     *
13180     * A disabled item cannot be selected or unselected. It will also
13181     * change its appearance (generally greyed out). This sets the
13182     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13183     * enabled).
13184     *
13185     * @ingroup List
13186     */
13187    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13188
13189    /**
13190     * Get a value whether list item is disabled or not.
13191     *
13192     * @param it The item.
13193     * @return The disabled state.
13194     *
13195     * @see elm_list_item_disabled_set() for more details.
13196     *
13197     * @ingroup List
13198     */
13199    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13200
13201    /**
13202     * Set the text to be shown in a given list item's tooltips.
13203     *
13204     * @param item Target item.
13205     * @param text The text to set in the content.
13206     *
13207     * Setup the text as tooltip to object. The item can have only one tooltip,
13208     * so any previous tooltip data - set with this function or
13209     * elm_list_item_tooltip_content_cb_set() - is removed.
13210     *
13211     * @see elm_object_tooltip_text_set() for more details.
13212     *
13213     * @ingroup List
13214     */
13215    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13216
13217
13218    /**
13219     * @brief Disable size restrictions on an object's tooltip
13220     * @param item The tooltip's anchor object
13221     * @param disable If EINA_TRUE, size restrictions are disabled
13222     * @return EINA_FALSE on failure, EINA_TRUE on success
13223     *
13224     * This function allows a tooltip to expand beyond its parant window's canvas.
13225     * It will instead be limited only by the size of the display.
13226     */
13227    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13228    /**
13229     * @brief Retrieve size restriction state of an object's tooltip
13230     * @param obj The tooltip's anchor object
13231     * @return If EINA_TRUE, size restrictions are disabled
13232     *
13233     * This function returns whether a tooltip is allowed to expand beyond
13234     * its parant window's canvas.
13235     * It will instead be limited only by the size of the display.
13236     */
13237    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13238
13239    /**
13240     * Set the content to be shown in the tooltip item.
13241     *
13242     * Setup the tooltip to item. The item can have only one tooltip,
13243     * so any previous tooltip data is removed. @p func(with @p data) will
13244     * be called every time that need show the tooltip and it should
13245     * return a valid Evas_Object. This object is then managed fully by
13246     * tooltip system and is deleted when the tooltip is gone.
13247     *
13248     * @param item the list item being attached a tooltip.
13249     * @param func the function used to create the tooltip contents.
13250     * @param data what to provide to @a func as callback data/context.
13251     * @param del_cb called when data is not needed anymore, either when
13252     *        another callback replaces @a func, the tooltip is unset with
13253     *        elm_list_item_tooltip_unset() or the owner @a item
13254     *        dies. This callback receives as the first parameter the
13255     *        given @a data, and @c event_info is the item.
13256     *
13257     * @see elm_object_tooltip_content_cb_set() for more details.
13258     *
13259     * @ingroup List
13260     */
13261    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);
13262
13263    /**
13264     * Unset tooltip from item.
13265     *
13266     * @param item list item to remove previously set tooltip.
13267     *
13268     * Remove tooltip from item. The callback provided as del_cb to
13269     * elm_list_item_tooltip_content_cb_set() will be called to notify
13270     * it is not used anymore.
13271     *
13272     * @see elm_object_tooltip_unset() for more details.
13273     * @see elm_list_item_tooltip_content_cb_set()
13274     *
13275     * @ingroup List
13276     */
13277    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13278
13279    /**
13280     * Sets a different style for this item tooltip.
13281     *
13282     * @note before you set a style you should define a tooltip with
13283     *       elm_list_item_tooltip_content_cb_set() or
13284     *       elm_list_item_tooltip_text_set()
13285     *
13286     * @param item list item with tooltip already set.
13287     * @param style the theme style to use (default, transparent, ...)
13288     *
13289     * @see elm_object_tooltip_style_set() for more details.
13290     *
13291     * @ingroup List
13292     */
13293    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13294
13295    /**
13296     * Get the style for this item tooltip.
13297     *
13298     * @param item list item with tooltip already set.
13299     * @return style the theme style in use, defaults to "default". If the
13300     *         object does not have a tooltip set, then NULL is returned.
13301     *
13302     * @see elm_object_tooltip_style_get() for more details.
13303     * @see elm_list_item_tooltip_style_set()
13304     *
13305     * @ingroup List
13306     */
13307    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13308
13309    /**
13310     * Set the type of mouse pointer/cursor decoration to be shown,
13311     * when the mouse pointer is over the given list widget item
13312     *
13313     * @param item list item to customize cursor on
13314     * @param cursor the cursor type's name
13315     *
13316     * This function works analogously as elm_object_cursor_set(), but
13317     * here the cursor's changing area is restricted to the item's
13318     * area, and not the whole widget's. Note that that item cursors
13319     * have precedence over widget cursors, so that a mouse over an
13320     * item with custom cursor set will always show @b that cursor.
13321     *
13322     * If this function is called twice for an object, a previously set
13323     * cursor will be unset on the second call.
13324     *
13325     * @see elm_object_cursor_set()
13326     * @see elm_list_item_cursor_get()
13327     * @see elm_list_item_cursor_unset()
13328     *
13329     * @ingroup List
13330     */
13331    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13332
13333    /*
13334     * Get the type of mouse pointer/cursor decoration set to be shown,
13335     * when the mouse pointer is over the given list widget item
13336     *
13337     * @param item list item with custom cursor set
13338     * @return the cursor type's name or @c NULL, if no custom cursors
13339     * were set to @p item (and on errors)
13340     *
13341     * @see elm_object_cursor_get()
13342     * @see elm_list_item_cursor_set()
13343     * @see elm_list_item_cursor_unset()
13344     *
13345     * @ingroup List
13346     */
13347    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13348
13349    /**
13350     * Unset any custom mouse pointer/cursor decoration set to be
13351     * shown, when the mouse pointer is over the given list widget
13352     * item, thus making it show the @b default cursor again.
13353     *
13354     * @param item a list item
13355     *
13356     * Use this call to undo any custom settings on this item's cursor
13357     * decoration, bringing it back to defaults (no custom style set).
13358     *
13359     * @see elm_object_cursor_unset()
13360     * @see elm_list_item_cursor_set()
13361     *
13362     * @ingroup List
13363     */
13364    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13365
13366    /**
13367     * Set a different @b style for a given custom cursor set for a
13368     * list item.
13369     *
13370     * @param item list item with custom cursor set
13371     * @param style the <b>theme style</b> to use (e.g. @c "default",
13372     * @c "transparent", etc)
13373     *
13374     * This function only makes sense when one is using custom mouse
13375     * cursor decorations <b>defined in a theme file</b>, which can have,
13376     * given a cursor name/type, <b>alternate styles</b> on it. It
13377     * works analogously as elm_object_cursor_style_set(), but here
13378     * applyed only to list item objects.
13379     *
13380     * @warning Before you set a cursor style you should have definen a
13381     *       custom cursor previously on the item, with
13382     *       elm_list_item_cursor_set()
13383     *
13384     * @see elm_list_item_cursor_engine_only_set()
13385     * @see elm_list_item_cursor_style_get()
13386     *
13387     * @ingroup List
13388     */
13389    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13390
13391    /**
13392     * Get the current @b style set for a given list item's custom
13393     * cursor
13394     *
13395     * @param item list item with custom cursor set.
13396     * @return style the cursor style in use. If the object does not
13397     *         have a cursor set, then @c NULL is returned.
13398     *
13399     * @see elm_list_item_cursor_style_set() for more details
13400     *
13401     * @ingroup List
13402     */
13403    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13404
13405    /**
13406     * Set if the (custom)cursor for a given list item should be
13407     * searched in its theme, also, or should only rely on the
13408     * rendering engine.
13409     *
13410     * @param item item with custom (custom) cursor already set on
13411     * @param engine_only Use @c EINA_TRUE to have cursors looked for
13412     * only on those provided by the rendering engine, @c EINA_FALSE to
13413     * have them searched on the widget's theme, as well.
13414     *
13415     * @note This call is of use only if you've set a custom cursor
13416     * for list items, with elm_list_item_cursor_set().
13417     *
13418     * @note By default, cursors will only be looked for between those
13419     * provided by the rendering engine.
13420     *
13421     * @ingroup List
13422     */
13423    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13424
13425    /**
13426     * Get if the (custom) cursor for a given list item is being
13427     * searched in its theme, also, or is only relying on the rendering
13428     * engine.
13429     *
13430     * @param item a list item
13431     * @return @c EINA_TRUE, if cursors are being looked for only on
13432     * those provided by the rendering engine, @c EINA_FALSE if they
13433     * are being searched on the widget's theme, as well.
13434     *
13435     * @see elm_list_item_cursor_engine_only_set(), for more details
13436     *
13437     * @ingroup List
13438     */
13439    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13440
13441    /**
13442     * @}
13443     */
13444
13445    /**
13446     * @defgroup Slider Slider
13447     * @ingroup Elementary
13448     *
13449     * @image html img/widget/slider/preview-00.png
13450     * @image latex img/widget/slider/preview-00.eps width=\textwidth
13451     *
13452     * The slider adds a dragable “slider” widget for selecting the value of
13453     * something within a range.
13454     *
13455     * A slider can be horizontal or vertical. It can contain an Icon and has a
13456     * primary label as well as a units label (that is formatted with floating
13457     * point values and thus accepts a printf-style format string, like
13458     * “%1.2f units”. There is also an indicator string that may be somewhere
13459     * else (like on the slider itself) that also accepts a format string like
13460     * units. Label, Icon Unit and Indicator strings/objects are optional.
13461     *
13462     * A slider may be inverted which means values invert, with high vales being
13463     * on the left or top and low values on the right or bottom (as opposed to
13464     * normally being low on the left or top and high on the bottom and right).
13465     *
13466     * The slider should have its minimum and maximum values set by the
13467     * application with  elm_slider_min_max_set() and value should also be set by
13468     * the application before use with  elm_slider_value_set(). The span of the
13469     * slider is its length (horizontally or vertically). This will be scaled by
13470     * the object or applications scaling factor. At any point code can query the
13471     * slider for its value with elm_slider_value_get().
13472     *
13473     * Smart callbacks one can listen to:
13474     * - "changed" - Whenever the slider value is changed by the user.
13475     * - "slider,drag,start" - dragging the slider indicator around has started.
13476     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13477     * - "delay,changed" - A short time after the value is changed by the user.
13478     * This will be called only when the user stops dragging for
13479     * a very short period or when they release their
13480     * finger/mouse, so it avoids possibly expensive reactions to
13481     * the value change.
13482     *
13483     * Available styles for it:
13484     * - @c "default"
13485     *
13486     * Here is an example on its usage:
13487     * @li @ref slider_example
13488     */
13489
13490    /**
13491     * @addtogroup Slider
13492     * @{
13493     */
13494
13495    /**
13496     * Add a new slider widget to the given parent Elementary
13497     * (container) object.
13498     *
13499     * @param parent The parent object.
13500     * @return a new slider widget handle or @c NULL, on errors.
13501     *
13502     * This function inserts a new slider widget on the canvas.
13503     *
13504     * @ingroup Slider
13505     */
13506    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13507
13508    /**
13509     * Set the label of a given slider widget
13510     *
13511     * @param obj The progress bar object
13512     * @param label The text label string, in UTF-8
13513     *
13514     * @ingroup Slider
13515     * @deprecated use elm_object_text_set() instead.
13516     */
13517    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13518
13519    /**
13520     * Get the label of a given slider widget
13521     *
13522     * @param obj The progressbar object
13523     * @return The text label string, in UTF-8
13524     *
13525     * @ingroup Slider
13526     * @deprecated use elm_object_text_get() instead.
13527     */
13528    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13529
13530    /**
13531     * Set the icon object of the slider object.
13532     *
13533     * @param obj The slider object.
13534     * @param icon The icon object.
13535     *
13536     * On horizontal mode, icon is placed at left, and on vertical mode,
13537     * placed at top.
13538     *
13539     * @note Once the icon object is set, a previously set one will be deleted.
13540     * If you want to keep that old content object, use the
13541     * elm_slider_icon_unset() function.
13542     *
13543     * @warning If the object being set does not have minimum size hints set,
13544     * it won't get properly displayed.
13545     *
13546     * @ingroup Slider
13547     */
13548    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13549
13550    /**
13551     * Unset an icon set on a given slider widget.
13552     *
13553     * @param obj The slider object.
13554     * @return The icon object that was being used, if any was set, or
13555     * @c NULL, otherwise (and on errors).
13556     *
13557     * On horizontal mode, icon is placed at left, and on vertical mode,
13558     * placed at top.
13559     *
13560     * This call will unparent and return the icon object which was set
13561     * for this widget, previously, on success.
13562     *
13563     * @see elm_slider_icon_set() for more details
13564     * @see elm_slider_icon_get()
13565     *
13566     * @ingroup Slider
13567     */
13568    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13569
13570    /**
13571     * Retrieve the icon object set for a given slider widget.
13572     *
13573     * @param obj The slider object.
13574     * @return The icon object's handle, if @p obj had one set, or @c NULL,
13575     * otherwise (and on errors).
13576     *
13577     * On horizontal mode, icon is placed at left, and on vertical mode,
13578     * placed at top.
13579     *
13580     * @see elm_slider_icon_set() for more details
13581     * @see elm_slider_icon_unset()
13582     *
13583     * @ingroup Slider
13584     */
13585    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13586
13587    /**
13588     * Set the end object of the slider object.
13589     *
13590     * @param obj The slider object.
13591     * @param end The end object.
13592     *
13593     * On horizontal mode, end is placed at left, and on vertical mode,
13594     * placed at bottom.
13595     *
13596     * @note Once the icon object is set, a previously set one will be deleted.
13597     * If you want to keep that old content object, use the
13598     * elm_slider_end_unset() function.
13599     *
13600     * @warning If the object being set does not have minimum size hints set,
13601     * it won't get properly displayed.
13602     *
13603     * @ingroup Slider
13604     */
13605    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13606
13607    /**
13608     * Unset an end object set on a given slider widget.
13609     *
13610     * @param obj The slider object.
13611     * @return The end object that was being used, if any was set, or
13612     * @c NULL, otherwise (and on errors).
13613     *
13614     * On horizontal mode, end is placed at left, and on vertical mode,
13615     * placed at bottom.
13616     *
13617     * This call will unparent and return the icon object which was set
13618     * for this widget, previously, on success.
13619     *
13620     * @see elm_slider_end_set() for more details.
13621     * @see elm_slider_end_get()
13622     *
13623     * @ingroup Slider
13624     */
13625    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13626
13627    /**
13628     * Retrieve the end object set for a given slider widget.
13629     *
13630     * @param obj The slider object.
13631     * @return The end object's handle, if @p obj had one set, or @c NULL,
13632     * otherwise (and on errors).
13633     *
13634     * On horizontal mode, icon is placed at right, and on vertical mode,
13635     * placed at bottom.
13636     *
13637     * @see elm_slider_end_set() for more details.
13638     * @see elm_slider_end_unset()
13639     *
13640     * @ingroup Slider
13641     */
13642    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13643
13644    /**
13645     * Set the (exact) length of the bar region of a given slider widget.
13646     *
13647     * @param obj The slider object.
13648     * @param size The length of the slider's bar region.
13649     *
13650     * This sets the minimum width (when in horizontal mode) or height
13651     * (when in vertical mode) of the actual bar area of the slider
13652     * @p obj. This in turn affects the object's minimum size. Use
13653     * this when you're not setting other size hints expanding on the
13654     * given direction (like weight and alignment hints) and you would
13655     * like it to have a specific size.
13656     *
13657     * @note Icon, end, label, indicator and unit text around @p obj
13658     * will require their
13659     * own space, which will make @p obj to require more the @p size,
13660     * actually.
13661     *
13662     * @see elm_slider_span_size_get()
13663     *
13664     * @ingroup Slider
13665     */
13666    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13667
13668    /**
13669     * Get the length set for the bar region of a given slider widget
13670     *
13671     * @param obj The slider object.
13672     * @return The length of the slider's bar region.
13673     *
13674     * If that size was not set previously, with
13675     * elm_slider_span_size_set(), this call will return @c 0.
13676     *
13677     * @ingroup Slider
13678     */
13679    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13680
13681    /**
13682     * Set the format string for the unit label.
13683     *
13684     * @param obj The slider object.
13685     * @param format The format string for the unit display.
13686     *
13687     * Unit label is displayed all the time, if set, after slider's bar.
13688     * In horizontal mode, at right and in vertical mode, at bottom.
13689     *
13690     * If @c NULL, unit label won't be visible. If not it sets the format
13691     * string for the label text. To the label text is provided a floating point
13692     * value, so the label text can display up to 1 floating point value.
13693     * Note that this is optional.
13694     *
13695     * Use a format string such as "%1.2f meters" for example, and it will
13696     * display values like: "3.14 meters" for a value equal to 3.14159.
13697     *
13698     * Default is unit label disabled.
13699     *
13700     * @see elm_slider_indicator_format_get()
13701     *
13702     * @ingroup Slider
13703     */
13704    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13705
13706    /**
13707     * Get the unit label format of the slider.
13708     *
13709     * @param obj The slider object.
13710     * @return The unit label format string in UTF-8.
13711     *
13712     * Unit label is displayed all the time, if set, after slider's bar.
13713     * In horizontal mode, at right and in vertical mode, at bottom.
13714     *
13715     * @see elm_slider_unit_format_set() for more
13716     * information on how this works.
13717     *
13718     * @ingroup Slider
13719     */
13720    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13721
13722    /**
13723     * Set the format string for the indicator label.
13724     *
13725     * @param obj The slider object.
13726     * @param indicator The format string for the indicator display.
13727     *
13728     * The slider may display its value somewhere else then unit label,
13729     * for example, above the slider knob that is dragged around. This function
13730     * sets the format string used for this.
13731     *
13732     * If @c NULL, indicator label won't be visible. If not it sets the format
13733     * string for the label text. To the label text is provided a floating point
13734     * value, so the label text can display up to 1 floating point value.
13735     * Note that this is optional.
13736     *
13737     * Use a format string such as "%1.2f meters" for example, and it will
13738     * display values like: "3.14 meters" for a value equal to 3.14159.
13739     *
13740     * Default is indicator label disabled.
13741     *
13742     * @see elm_slider_indicator_format_get()
13743     *
13744     * @ingroup Slider
13745     */
13746    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13747
13748    /**
13749     * Get the indicator label format of the slider.
13750     *
13751     * @param obj The slider object.
13752     * @return The indicator label format string in UTF-8.
13753     *
13754     * The slider may display its value somewhere else then unit label,
13755     * for example, above the slider knob that is dragged around. This function
13756     * gets the format string used for this.
13757     *
13758     * @see elm_slider_indicator_format_set() for more
13759     * information on how this works.
13760     *
13761     * @ingroup Slider
13762     */
13763    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13764
13765    /**
13766     * Set the format function pointer for the indicator label
13767     *
13768     * @param obj The slider object.
13769     * @param func The indicator format function.
13770     * @param free_func The freeing function for the format string.
13771     *
13772     * Set the callback function to format the indicator string.
13773     *
13774     * @see elm_slider_indicator_format_set() for more info on how this works.
13775     *
13776     * @ingroup Slider
13777     */
13778   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);
13779
13780   /**
13781    * Set the format function pointer for the units label
13782    *
13783    * @param obj The slider object.
13784    * @param func The units format function.
13785    * @param free_func The freeing function for the format string.
13786    *
13787    * Set the callback function to format the indicator string.
13788    *
13789    * @see elm_slider_units_format_set() for more info on how this works.
13790    *
13791    * @ingroup Slider
13792    */
13793   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);
13794
13795   /**
13796    * Set the orientation of a given slider widget.
13797    *
13798    * @param obj The slider object.
13799    * @param horizontal Use @c EINA_TRUE to make @p obj to be
13800    * @b horizontal, @c EINA_FALSE to make it @b vertical.
13801    *
13802    * Use this function to change how your slider is to be
13803    * disposed: vertically or horizontally.
13804    *
13805    * By default it's displayed horizontally.
13806    *
13807    * @see elm_slider_horizontal_get()
13808    *
13809    * @ingroup Slider
13810    */
13811    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13812
13813    /**
13814     * Retrieve the orientation of a given slider widget
13815     *
13816     * @param obj The slider object.
13817     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
13818     * @c EINA_FALSE if it's @b vertical (and on errors).
13819     *
13820     * @see elm_slider_horizontal_set() for more details.
13821     *
13822     * @ingroup Slider
13823     */
13824    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13825
13826    /**
13827     * Set the minimum and maximum values for the slider.
13828     *
13829     * @param obj The slider object.
13830     * @param min The minimum value.
13831     * @param max The maximum value.
13832     *
13833     * Define the allowed range of values to be selected by the user.
13834     *
13835     * If actual value is less than @p min, it will be updated to @p min. If it
13836     * is bigger then @p max, will be updated to @p max. Actual value can be
13837     * get with elm_slider_value_get().
13838     *
13839     * By default, min is equal to 0.0, and max is equal to 1.0.
13840     *
13841     * @warning Maximum must be greater than minimum, otherwise behavior
13842     * is undefined.
13843     *
13844     * @see elm_slider_min_max_get()
13845     *
13846     * @ingroup Slider
13847     */
13848    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
13849
13850    /**
13851     * Get the minimum and maximum values of the slider.
13852     *
13853     * @param obj The slider object.
13854     * @param min Pointer where to store the minimum value.
13855     * @param max Pointer where to store the maximum value.
13856     *
13857     * @note If only one value is needed, the other pointer can be passed
13858     * as @c NULL.
13859     *
13860     * @see elm_slider_min_max_set() for details.
13861     *
13862     * @ingroup Slider
13863     */
13864    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
13865
13866    /**
13867     * Set the value the slider displays.
13868     *
13869     * @param obj The slider object.
13870     * @param val The value to be displayed.
13871     *
13872     * Value will be presented on the unit label following format specified with
13873     * elm_slider_unit_format_set() and on indicator with
13874     * elm_slider_indicator_format_set().
13875     *
13876     * @warning The value must to be between min and max values. This values
13877     * are set by elm_slider_min_max_set().
13878     *
13879     * @see elm_slider_value_get()
13880     * @see elm_slider_unit_format_set()
13881     * @see elm_slider_indicator_format_set()
13882     * @see elm_slider_min_max_set()
13883     *
13884     * @ingroup Slider
13885     */
13886    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13887
13888    /**
13889     * Get the value displayed by the spinner.
13890     *
13891     * @param obj The spinner object.
13892     * @return The value displayed.
13893     *
13894     * @see elm_spinner_value_set() for details.
13895     *
13896     * @ingroup Slider
13897     */
13898    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13899
13900    /**
13901     * Invert a given slider widget's displaying values order
13902     *
13903     * @param obj The slider object.
13904     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
13905     * @c EINA_FALSE to bring it back to default, non-inverted values.
13906     *
13907     * A slider may be @b inverted, in which state it gets its
13908     * values inverted, with high vales being on the left or top and
13909     * low values on the right or bottom, as opposed to normally have
13910     * the low values on the former and high values on the latter,
13911     * respectively, for horizontal and vertical modes.
13912     *
13913     * @see elm_slider_inverted_get()
13914     *
13915     * @ingroup Slider
13916     */
13917    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
13918
13919    /**
13920     * Get whether a given slider widget's displaying values are
13921     * inverted or not.
13922     *
13923     * @param obj The slider object.
13924     * @return @c EINA_TRUE, if @p obj has inverted values,
13925     * @c EINA_FALSE otherwise (and on errors).
13926     *
13927     * @see elm_slider_inverted_set() for more details.
13928     *
13929     * @ingroup Slider
13930     */
13931    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13932
13933    /**
13934     * Set whether to enlarge slider indicator (augmented knob) or not.
13935     *
13936     * @param obj The slider object.
13937     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
13938     * let the knob always at default size.
13939     *
13940     * By default, indicator will be bigger while dragged by the user.
13941     *
13942     * @warning It won't display values set with
13943     * elm_slider_indicator_format_set() if you disable indicator.
13944     *
13945     * @ingroup Slider
13946     */
13947    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
13948
13949    /**
13950     * Get whether a given slider widget's enlarging indicator or not.
13951     *
13952     * @param obj The slider object.
13953     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
13954     * @c EINA_FALSE otherwise (and on errors).
13955     *
13956     * @see elm_slider_indicator_show_set() for details.
13957     *
13958     * @ingroup Slider
13959     */
13960    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13961
13962    /**
13963     * @}
13964     */
13965
13966    /**
13967     * @addtogroup Actionslider Actionslider
13968     *
13969     * @image html img/widget/actionslider/preview-00.png
13970     * @image latex img/widget/actionslider/preview-00.eps
13971     *
13972     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
13973     * properties. The indicator is the element the user drags to choose a label.
13974     * When the position is set with magnet, when released the indicator will be
13975     * moved to it if it's nearest the magnetized position.
13976     *
13977     * @note By default all positions are set as enabled.
13978     *
13979     * Signals that you can add callbacks for are:
13980     *
13981     * "selected" - when user selects an enabled position (the label is passed
13982     *              as event info)".
13983     * @n
13984     * "pos_changed" - when the indicator reaches any of the positions("left",
13985     *                 "right" or "center").
13986     *
13987     * See an example of actionslider usage @ref actionslider_example_page "here"
13988     * @{
13989     */
13990    typedef enum _Elm_Actionslider_Pos
13991      {
13992         ELM_ACTIONSLIDER_NONE = 0,
13993         ELM_ACTIONSLIDER_LEFT = 1 << 0,
13994         ELM_ACTIONSLIDER_CENTER = 1 << 1,
13995         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
13996         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
13997      } Elm_Actionslider_Pos;
13998
13999    /**
14000     * Add a new actionslider to the parent.
14001     *
14002     * @param parent The parent object
14003     * @return The new actionslider object or NULL if it cannot be created
14004     */
14005    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14006    /**
14007     * Set actionslider labels.
14008     *
14009     * @param obj The actionslider object
14010     * @param left_label The label to be set on the left.
14011     * @param center_label The label to be set on the center.
14012     * @param right_label The label to be set on the right.
14013     * @deprecated use elm_object_text_set() instead.
14014     */
14015    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
14016    /**
14017     * Get actionslider labels.
14018     *
14019     * @param obj The actionslider object
14020     * @param left_label A char** to place the left_label of @p obj into.
14021     * @param center_label A char** to place the center_label of @p obj into.
14022     * @param right_label A char** to place the right_label of @p obj into.
14023     * @deprecated use elm_object_text_set() instead.
14024     */
14025    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label) EINA_ARG_NONNULL(1);
14026    /**
14027     * Get actionslider selected label.
14028     *
14029     * @param obj The actionslider object
14030     * @return The selected label
14031     */
14032    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14033    /**
14034     * Set actionslider indicator position.
14035     *
14036     * @param obj The actionslider object.
14037     * @param pos The position of the indicator.
14038     */
14039    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14040    /**
14041     * Get actionslider indicator position.
14042     *
14043     * @param obj The actionslider object.
14044     * @return The position of the indicator.
14045     */
14046    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14047    /**
14048     * Set actionslider magnet position. To make multiple positions magnets @c or
14049     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14050     *
14051     * @param obj The actionslider object.
14052     * @param pos Bit mask indicating the magnet positions.
14053     */
14054    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14055    /**
14056     * Get actionslider magnet position.
14057     *
14058     * @param obj The actionslider object.
14059     * @return The positions with magnet property.
14060     */
14061    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14062    /**
14063     * Set actionslider enabled position. To set multiple positions as enabled @c or
14064     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14065     *
14066     * @note All the positions are enabled by default.
14067     *
14068     * @param obj The actionslider object.
14069     * @param pos Bit mask indicating the enabled positions.
14070     */
14071    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14072    /**
14073     * Get actionslider enabled position.
14074     *
14075     * @param obj The actionslider object.
14076     * @return The enabled positions.
14077     */
14078    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14079    /**
14080     * Set the label used on the indicator.
14081     *
14082     * @param obj The actionslider object
14083     * @param label The label to be set on the indicator.
14084     * @deprecated use elm_object_text_set() instead.
14085     */
14086    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14087    /**
14088     * Get the label used on the indicator object.
14089     *
14090     * @param obj The actionslider object
14091     * @return The indicator label
14092     * @deprecated use elm_object_text_get() instead.
14093     */
14094    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14095    /**
14096     * @}
14097     */
14098
14099    /**
14100     * @defgroup Genlist Genlist
14101     *
14102     * @image html img/widget/genlist/preview-00.png
14103     * @image latex img/widget/genlist/preview-00.eps
14104     * @image html img/genlist.png
14105     * @image latex img/genlist.eps
14106     *
14107     * This widget aims to have more expansive list than the simple list in
14108     * Elementary that could have more flexible items and allow many more entries
14109     * while still being fast and low on memory usage. At the same time it was
14110     * also made to be able to do tree structures. But the price to pay is more
14111     * complexity when it comes to usage. If all you want is a simple list with
14112     * icons and a single label, use the normal @ref List object.
14113     *
14114     * Genlist has a fairly large API, mostly because it's relatively complex,
14115     * trying to be both expansive, powerful and efficient. First we will begin
14116     * an overview on the theory behind genlist.
14117     *
14118     * @section Genlist_Item_Class Genlist item classes - creating items
14119     *
14120     * In order to have the ability to add and delete items on the fly, genlist
14121     * implements a class (callback) system where the application provides a
14122     * structure with information about that type of item (genlist may contain
14123     * multiple different items with different classes, states and styles).
14124     * Genlist will call the functions in this struct (methods) when an item is
14125     * "realized" (i.e., created dynamically, while the user is scrolling the
14126     * grid). All objects will simply be deleted when no longer needed with
14127     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14128     * following members:
14129     * - @c item_style - This is a constant string and simply defines the name
14130     *   of the item style. It @b must be specified and the default should be @c
14131     *   "default".
14132     *
14133     * - @c func - A struct with pointers to functions that will be called when
14134     *   an item is going to be actually created. All of them receive a @c data
14135     *   parameter that will point to the same data passed to
14136     *   elm_genlist_item_append() and related item creation functions, and a @c
14137     *   obj parameter that points to the genlist object itself.
14138     *
14139     * The function pointers inside @c func are @c label_get, @c icon_get, @c
14140     * state_get and @c del. The 3 first functions also receive a @c part
14141     * parameter described below. A brief description of these functions follows:
14142     *
14143     * - @c label_get - The @c part parameter is the name string of one of the
14144     *   existing text parts in the Edje group implementing the item's theme.
14145     *   This function @b must return a strdup'()ed string, as the caller will
14146     *   free() it when done. See #GenlistItemLabelGetFunc.
14147     * - @c icon_get - The @c part parameter is the name string of one of the
14148     *   existing (icon) swallow parts in the Edje group implementing the item's
14149     *   theme. It must return @c NULL, when no icon is desired, or a valid
14150     *   object handle, otherwise.  The object will be deleted by the genlist on
14151     *   its deletion or when the item is "unrealized".  See
14152     *   #GenlistItemIconGetFunc.
14153     * - @c func.state_get - The @c part parameter is the name string of one of
14154     *   the state parts in the Edje group implementing the item's theme. Return
14155     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14156     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14157     *   and @c "elm" as "emission" and "source" arguments, respectively, when
14158     *   the state is true (the default is false), where @c XXX is the name of
14159     *   the (state) part.  See #GenlistItemStateGetFunc.
14160     * - @c func.del - This is intended for use when genlist items are deleted,
14161     *   so any data attached to the item (e.g. its data parameter on creation)
14162     *   can be deleted. See #GenlistItemDelFunc.
14163     *
14164     * available item styles:
14165     * - default
14166     * - default_style - The text part is a textblock
14167     *
14168     * @image html img/widget/genlist/preview-04.png
14169     * @image latex img/widget/genlist/preview-04.eps
14170     *
14171     * - double_label
14172     *
14173     * @image html img/widget/genlist/preview-01.png
14174     * @image latex img/widget/genlist/preview-01.eps
14175     *
14176     * - icon_top_text_bottom
14177     *
14178     * @image html img/widget/genlist/preview-02.png
14179     * @image latex img/widget/genlist/preview-02.eps
14180     *
14181     * - group_index
14182     *
14183     * @image html img/widget/genlist/preview-03.png
14184     * @image latex img/widget/genlist/preview-03.eps
14185     *
14186     * @section Genlist_Items Structure of items
14187     *
14188     * An item in a genlist can have 0 or more text labels (they can be regular
14189     * text or textblock Evas objects - that's up to the style to determine), 0
14190     * or more icons (which are simply objects swallowed into the genlist item's
14191     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14192     * behavior left to the user to define. The Edje part names for each of
14193     * these properties will be looked up, in the theme file for the genlist,
14194     * under the Edje (string) data items named @c "labels", @c "icons" and @c
14195     * "states", respectively. For each of those properties, if more than one
14196     * part is provided, they must have names listed separated by spaces in the
14197     * data fields. For the default genlist item theme, we have @b one label
14198     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14199     * "elm.swallow.end") and @b no state parts.
14200     *
14201     * A genlist item may be at one of several styles. Elementary provides one
14202     * by default - "default", but this can be extended by system or application
14203     * custom themes/overlays/extensions (see @ref Theme "themes" for more
14204     * details).
14205     *
14206     * @section Genlist_Manipulation Editing and Navigating
14207     *
14208     * Items can be added by several calls. All of them return a @ref
14209     * Elm_Genlist_Item handle that is an internal member inside the genlist.
14210     * They all take a data parameter that is meant to be used for a handle to
14211     * the applications internal data (eg the struct with the original item
14212     * data). The parent parameter is the parent genlist item this belongs to if
14213     * it is a tree or an indexed group, and NULL if there is no parent. The
14214     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14215     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14216     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14217     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
14218     * is set then this item is group index item that is displayed at the top
14219     * until the next group comes. The func parameter is a convenience callback
14220     * that is called when the item is selected and the data parameter will be
14221     * the func_data parameter, obj be the genlist object and event_info will be
14222     * the genlist item.
14223     *
14224     * elm_genlist_item_append() adds an item to the end of the list, or if
14225     * there is a parent, to the end of all the child items of the parent.
14226     * elm_genlist_item_prepend() is the same but adds to the beginning of
14227     * the list or children list. elm_genlist_item_insert_before() inserts at
14228     * item before another item and elm_genlist_item_insert_after() inserts after
14229     * the indicated item.
14230     *
14231     * The application can clear the list with elm_genlist_clear() which deletes
14232     * all the items in the list and elm_genlist_item_del() will delete a specific
14233     * item. elm_genlist_item_subitems_clear() will clear all items that are
14234     * children of the indicated parent item.
14235     *
14236     * To help inspect list items you can jump to the item at the top of the list
14237     * with elm_genlist_first_item_get() which will return the item pointer, and
14238     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14239     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14240     * and previous items respectively relative to the indicated item. Using
14241     * these calls you can walk the entire item list/tree. Note that as a tree
14242     * the items are flattened in the list, so elm_genlist_item_parent_get() will
14243     * let you know which item is the parent (and thus know how to skip them if
14244     * wanted).
14245     *
14246     * @section Genlist_Muti_Selection Multi-selection
14247     *
14248     * If the application wants multiple items to be able to be selected,
14249     * elm_genlist_multi_select_set() can enable this. If the list is
14250     * single-selection only (the default), then elm_genlist_selected_item_get()
14251     * will return the selected item, if any, or NULL I none is selected. If the
14252     * list is multi-select then elm_genlist_selected_items_get() will return a
14253     * list (that is only valid as long as no items are modified (added, deleted,
14254     * selected or unselected)).
14255     *
14256     * @section Genlist_Usage_Hints Usage hints
14257     *
14258     * There are also convenience functions. elm_genlist_item_genlist_get() will
14259     * return the genlist object the item belongs to. elm_genlist_item_show()
14260     * will make the scroller scroll to show that specific item so its visible.
14261     * elm_genlist_item_data_get() returns the data pointer set by the item
14262     * creation functions.
14263     *
14264     * If an item changes (state of boolean changes, label or icons change),
14265     * then use elm_genlist_item_update() to have genlist update the item with
14266     * the new state. Genlist will re-realize the item thus call the functions
14267     * in the _Elm_Genlist_Item_Class for that item.
14268     *
14269     * To programmatically (un)select an item use elm_genlist_item_selected_set().
14270     * To get its selected state use elm_genlist_item_selected_get(). Similarly
14271     * to expand/contract an item and get its expanded state, use
14272     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14273     * again to make an item disabled (unable to be selected and appear
14274     * differently) use elm_genlist_item_disabled_set() to set this and
14275     * elm_genlist_item_disabled_get() to get the disabled state.
14276     *
14277     * In general to indicate how the genlist should expand items horizontally to
14278     * fill the list area, use elm_genlist_horizontal_mode_set(). Valid modes are
14279     * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14280     * mode means that if items are too wide to fit, the scroller will scroll
14281     * horizontally. Otherwise items are expanded to fill the width of the
14282     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14283     * to the viewport width and limited to that size. This can be combined with
14284     * a different style that uses edjes' ellipsis feature (cutting text off like
14285     * this: "tex...").
14286     *
14287     * Items will only call their selection func and callback when first becoming
14288     * selected. Any further clicks will do nothing, unless you enable always
14289     * select with elm_genlist_always_select_mode_set(). This means even if
14290     * selected, every click will make the selected callbacks be called.
14291     * elm_genlist_no_select_mode_set() will turn off the ability to select
14292     * items entirely and they will neither appear selected nor call selected
14293     * callback functions.
14294     *
14295     * Remember that you can create new styles and add your own theme augmentation
14296     * per application with elm_theme_extension_add(). If you absolutely must
14297     * have a specific style that overrides any theme the user or system sets up
14298     * you can use elm_theme_overlay_add() to add such a file.
14299     *
14300     * @section Genlist_Implementation Implementation
14301     *
14302     * Evas tracks every object you create. Every time it processes an event
14303     * (mouse move, down, up etc.) it needs to walk through objects and find out
14304     * what event that affects. Even worse every time it renders display updates,
14305     * in order to just calculate what to re-draw, it needs to walk through many
14306     * many many objects. Thus, the more objects you keep active, the more
14307     * overhead Evas has in just doing its work. It is advisable to keep your
14308     * active objects to the minimum working set you need. Also remember that
14309     * object creation and deletion carries an overhead, so there is a
14310     * middle-ground, which is not easily determined. But don't keep massive lists
14311     * of objects you can't see or use. Genlist does this with list objects. It
14312     * creates and destroys them dynamically as you scroll around. It groups them
14313     * into blocks so it can determine the visibility etc. of a whole block at
14314     * once as opposed to having to walk the whole list. This 2-level list allows
14315     * for very large numbers of items to be in the list (tests have used up to
14316     * 2,000,000 items). Also genlist employs a queue for adding items. As items
14317     * may be different sizes, every item added needs to be calculated as to its
14318     * size and thus this presents a lot of overhead on populating the list, this
14319     * genlist employs a queue. Any item added is queued and spooled off over
14320     * time, actually appearing some time later, so if your list has many members
14321     * you may find it takes a while for them to all appear, with your process
14322     * consuming a lot of CPU while it is busy spooling.
14323     *
14324     * Genlist also implements a tree structure, but it does so with callbacks to
14325     * the application, with the application filling in tree structures when
14326     * requested (allowing for efficient building of a very deep tree that could
14327     * even be used for file-management). See the above smart signal callbacks for
14328     * details.
14329     *
14330     * @section Genlist_Smart_Events Genlist smart events
14331     *
14332     * Signals that you can add callbacks for are:
14333     * - @c "activated" - The user has double-clicked or pressed
14334     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
14335     *   item that was activated.
14336     * - @c "clicked,double" - The user has double-clicked an item.  The @c
14337     *   event_info parameter is the item that was double-clicked.
14338     * - @c "selected" - This is called when a user has made an item selected.
14339     *   The event_info parameter is the genlist item that was selected.
14340     * - @c "unselected" - This is called when a user has made an item
14341     *   unselected. The event_info parameter is the genlist item that was
14342     *   unselected.
14343     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14344     *   called and the item is now meant to be expanded. The event_info
14345     *   parameter is the genlist item that was indicated to expand.  It is the
14346     *   job of this callback to then fill in the child items.
14347     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14348     *   called and the item is now meant to be contracted. The event_info
14349     *   parameter is the genlist item that was indicated to contract. It is the
14350     *   job of this callback to then delete the child items.
14351     * - @c "expand,request" - This is called when a user has indicated they want
14352     *   to expand a tree branch item. The callback should decide if the item can
14353     *   expand (has any children) and then call elm_genlist_item_expanded_set()
14354     *   appropriately to set the state. The event_info parameter is the genlist
14355     *   item that was indicated to expand.
14356     * - @c "contract,request" - This is called when a user has indicated they
14357     *   want to contract a tree branch item. The callback should decide if the
14358     *   item can contract (has any children) and then call
14359     *   elm_genlist_item_expanded_set() appropriately to set the state. The
14360     *   event_info parameter is the genlist item that was indicated to contract.
14361     * - @c "realized" - This is called when the item in the list is created as a
14362     *   real evas object. event_info parameter is the genlist item that was
14363     *   created. The object may be deleted at any time, so it is up to the
14364     *   caller to not use the object pointer from elm_genlist_item_object_get()
14365     *   in a way where it may point to freed objects.
14366     * - @c "unrealized" - This is called just before an item is unrealized.
14367     *   After this call icon objects provided will be deleted and the item
14368     *   object itself delete or be put into a floating cache.
14369     * - @c "drag,start,up" - This is called when the item in the list has been
14370     *   dragged (not scrolled) up.
14371     * - @c "drag,start,down" - This is called when the item in the list has been
14372     *   dragged (not scrolled) down.
14373     * - @c "drag,start,left" - This is called when the item in the list has been
14374     *   dragged (not scrolled) left.
14375     * - @c "drag,start,right" - This is called when the item in the list has
14376     *   been dragged (not scrolled) right.
14377     * - @c "drag,stop" - This is called when the item in the list has stopped
14378     *   being dragged.
14379     * - @c "drag" - This is called when the item in the list is being dragged.
14380     * - @c "longpressed" - This is called when the item is pressed for a certain
14381     *   amount of time. By default it's 1 second.
14382     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14383     *   the top edge.
14384     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14385     *   until the bottom edge.
14386     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14387     *   until the left edge.
14388     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14389     *   until the right edge.
14390     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14391     *   swiped left.
14392     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14393     *   swiped right.
14394     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14395     *   swiped up.
14396     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14397     *   swiped down.
14398     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14399     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
14400     *   multi-touch pinched in.
14401     * - @c "swipe" - This is called when the genlist is swiped.
14402     *
14403     * @section Genlist_Examples Examples
14404     *
14405     * Here is a list of examples that use the genlist, trying to show some of
14406     * its capabilities:
14407     * - @ref genlist_example_01
14408     * - @ref genlist_example_02
14409     * - @ref genlist_example_03
14410     * - @ref genlist_example_04
14411     * - @ref genlist_example_05
14412     */
14413
14414    /**
14415     * @addtogroup Genlist
14416     * @{
14417     */
14418
14419    /**
14420     * @enum _Elm_Genlist_Item_Flags
14421     * @typedef Elm_Genlist_Item_Flags
14422     *
14423     * Defines if the item is of any special type (has subitems or it's the
14424     * index of a group), or is just a simple item.
14425     *
14426     * @ingroup Genlist
14427     */
14428    typedef enum _Elm_Genlist_Item_Flags
14429      {
14430         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14431         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14432         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14433      } Elm_Genlist_Item_Flags;
14434    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
14435    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14436    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14437    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14438    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14439    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14440    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14441    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
14442
14443    /**
14444     * @struct _Elm_Genlist_Item_Class
14445     *
14446     * Genlist item class definition structs.
14447     *
14448     * This struct contains the style and fetching functions that will define the
14449     * contents of each item.
14450     *
14451     * @see @ref Genlist_Item_Class
14452     */
14453    struct _Elm_Genlist_Item_Class
14454      {
14455         const char                *item_style; /**< style of this class. */
14456         struct
14457           {
14458              GenlistItemLabelGetFunc  label_get; /**< Label fetching class function for genlist item classes.*/
14459              GenlistItemIconGetFunc   icon_get; /**< Icon fetching class function for genlist item classes. */
14460              GenlistItemStateGetFunc  state_get; /**< State fetching class function for genlist item classes. */
14461              GenlistItemDelFunc       del; /**< Deletion class function for genlist item classes. */
14462              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
14463           } func;
14464         const char                *mode_item_style;
14465      };
14466
14467    /**
14468     * Add a new genlist widget to the given parent Elementary
14469     * (container) object
14470     *
14471     * @param parent The parent object
14472     * @return a new genlist widget handle or @c NULL, on errors
14473     *
14474     * This function inserts a new genlist widget on the canvas.
14475     *
14476     * @see elm_genlist_item_append()
14477     * @see elm_genlist_item_del()
14478     * @see elm_genlist_clear()
14479     *
14480     * @ingroup Genlist
14481     */
14482    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14483    /**
14484     * Remove all items from a given genlist widget.
14485     *
14486     * @param obj The genlist object
14487     *
14488     * This removes (and deletes) all items in @p obj, leaving it empty.
14489     *
14490     * @see elm_genlist_item_del(), to remove just one item.
14491     *
14492     * @ingroup Genlist
14493     */
14494    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14495    /**
14496     * Enable or disable multi-selection in the genlist
14497     *
14498     * @param obj The genlist object
14499     * @param multi Multi-select enable/disable. Default is disabled.
14500     *
14501     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14502     * the list. This allows more than 1 item to be selected. To retrieve the list
14503     * of selected items, use elm_genlist_selected_items_get().
14504     *
14505     * @see elm_genlist_selected_items_get()
14506     * @see elm_genlist_multi_select_get()
14507     *
14508     * @ingroup Genlist
14509     */
14510    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14511    /**
14512     * Gets if multi-selection in genlist is enabled or disabled.
14513     *
14514     * @param obj The genlist object
14515     * @return Multi-select enabled/disabled
14516     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14517     *
14518     * @see elm_genlist_multi_select_set()
14519     *
14520     * @ingroup Genlist
14521     */
14522    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14523    /**
14524     * This sets the horizontal stretching mode.
14525     *
14526     * @param obj The genlist object
14527     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14528     *
14529     * This sets the mode used for sizing items horizontally. Valid modes
14530     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14531     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14532     * the scroller will scroll horizontally. Otherwise items are expanded
14533     * to fill the width of the viewport of the scroller. If it is
14534     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14535     * limited to that size.
14536     *
14537     * @see elm_genlist_horizontal_mode_get()
14538     *
14539     * @ingroup Genlist
14540     */
14541    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14542    /**
14543     * Gets the horizontal stretching mode.
14544     *
14545     * @param obj The genlist object
14546     * @return The mode to use
14547     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14548     *
14549     * @see elm_genlist_horizontal_mode_set()
14550     *
14551     * @ingroup Genlist
14552     */
14553    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14554    /**
14555     * Set the always select mode.
14556     *
14557     * @param obj The genlist object
14558     * @param always_select The always select mode (@c EINA_TRUE = on, @c
14559     * EINA_FALSE = off). Default is @c EINA_FALSE.
14560     *
14561     * Items will only call their selection func and callback when first
14562     * becoming selected. Any further clicks will do nothing, unless you
14563     * enable always select with elm_genlist_always_select_mode_set().
14564     * This means that, even if selected, every click will make the selected
14565     * callbacks be called.
14566     *
14567     * @see elm_genlist_always_select_mode_get()
14568     *
14569     * @ingroup Genlist
14570     */
14571    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14572    /**
14573     * Get the always select mode.
14574     *
14575     * @param obj The genlist object
14576     * @return The always select mode
14577     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14578     *
14579     * @see elm_genlist_always_select_mode_set()
14580     *
14581     * @ingroup Genlist
14582     */
14583    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14584    /**
14585     * Enable/disable the no select mode.
14586     *
14587     * @param obj The genlist object
14588     * @param no_select The no select mode
14589     * (EINA_TRUE = on, EINA_FALSE = off)
14590     *
14591     * This will turn off the ability to select items entirely and they
14592     * will neither appear selected nor call selected callback functions.
14593     *
14594     * @see elm_genlist_no_select_mode_get()
14595     *
14596     * @ingroup Genlist
14597     */
14598    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14599    /**
14600     * Gets whether the no select mode is enabled.
14601     *
14602     * @param obj The genlist object
14603     * @return The no select mode
14604     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14605     *
14606     * @see elm_genlist_no_select_mode_set()
14607     *
14608     * @ingroup Genlist
14609     */
14610    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14611    /**
14612     * Enable/disable compress mode.
14613     *
14614     * @param obj The genlist object
14615     * @param compress The compress mode
14616     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14617     *
14618     * This will enable the compress mode where items are "compressed"
14619     * horizontally to fit the genlist scrollable viewport width. This is
14620     * special for genlist.  Do not rely on
14621     * elm_genlist_horizontal_mode_set() being set to @c ELM_LIST_COMPRESS to
14622     * work as genlist needs to handle it specially.
14623     *
14624     * @see elm_genlist_compress_mode_get()
14625     *
14626     * @ingroup Genlist
14627     */
14628    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14629    /**
14630     * Get whether the compress mode is enabled.
14631     *
14632     * @param obj The genlist object
14633     * @return The compress mode
14634     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14635     *
14636     * @see elm_genlist_compress_mode_set()
14637     *
14638     * @ingroup Genlist
14639     */
14640    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14641    /**
14642     * Enable/disable height-for-width mode.
14643     *
14644     * @param obj The genlist object
14645     * @param setting The height-for-width mode (@c EINA_TRUE = on,
14646     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14647     *
14648     * With height-for-width mode the item width will be fixed (restricted
14649     * to a minimum of) to the list width when calculating its size in
14650     * order to allow the height to be calculated based on it. This allows,
14651     * for instance, text block to wrap lines if the Edje part is
14652     * configured with "text.min: 0 1".
14653     *
14654     * @note This mode will make list resize slower as it will have to
14655     *       recalculate every item height again whenever the list width
14656     *       changes!
14657     *
14658     * @note When height-for-width mode is enabled, it also enables
14659     *       compress mode (see elm_genlist_compress_mode_set()) and
14660     *       disables homogeneous (see elm_genlist_homogeneous_set()).
14661     *
14662     * @ingroup Genlist
14663     */
14664    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14665    /**
14666     * Get whether the height-for-width mode is enabled.
14667     *
14668     * @param obj The genlist object
14669     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14670     * off)
14671     *
14672     * @ingroup Genlist
14673     */
14674    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14675    /**
14676     * Enable/disable horizontal and vertical bouncing effect.
14677     *
14678     * @param obj The genlist object
14679     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14680     * EINA_FALSE = off). Default is @c EINA_FALSE.
14681     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14682     * EINA_FALSE = off). Default is @c EINA_TRUE.
14683     *
14684     * This will enable or disable the scroller bouncing effect for the
14685     * genlist. See elm_scroller_bounce_set() for details.
14686     *
14687     * @see elm_scroller_bounce_set()
14688     * @see elm_genlist_bounce_get()
14689     *
14690     * @ingroup Genlist
14691     */
14692    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14693    /**
14694     * Get whether the horizontal and vertical bouncing effect is enabled.
14695     *
14696     * @param obj The genlist object
14697     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14698     * option is set.
14699     * @param v_bounce Pointer to a bool to receive if the bounce vertically
14700     * option is set.
14701     *
14702     * @see elm_genlist_bounce_set()
14703     *
14704     * @ingroup Genlist
14705     */
14706    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14707    /**
14708     * Enable/disable homogenous mode.
14709     *
14710     * @param obj The genlist object
14711     * @param homogeneous Assume the items within the genlist are of the
14712     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14713     * EINA_FALSE.
14714     *
14715     * This will enable the homogeneous mode where items are of the same
14716     * height and width so that genlist may do the lazy-loading at its
14717     * maximum (which increases the performance for scrolling the list). This
14718     * implies 'compressed' mode.
14719     *
14720     * @see elm_genlist_compress_mode_set()
14721     * @see elm_genlist_homogeneous_get()
14722     *
14723     * @ingroup Genlist
14724     */
14725    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14726    /**
14727     * Get whether the homogenous mode is enabled.
14728     *
14729     * @param obj The genlist object
14730     * @return Assume the items within the genlist are of the same height
14731     * and width (EINA_TRUE = on, EINA_FALSE = off)
14732     *
14733     * @see elm_genlist_homogeneous_set()
14734     *
14735     * @ingroup Genlist
14736     */
14737    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14738    /**
14739     * Set the maximum number of items within an item block
14740     *
14741     * @param obj The genlist object
14742     * @param n   Maximum number of items within an item block. Default is 32.
14743     *
14744     * This will configure the block count to tune to the target with
14745     * particular performance matrix.
14746     *
14747     * A block of objects will be used to reduce the number of operations due to
14748     * many objects in the screen. It can determine the visibility, or if the
14749     * object has changed, it theme needs to be updated, etc. doing this kind of
14750     * calculation to the entire block, instead of per object.
14751     *
14752     * The default value for the block count is enough for most lists, so unless
14753     * you know you will have a lot of objects visible in the screen at the same
14754     * time, don't try to change this.
14755     *
14756     * @see elm_genlist_block_count_get()
14757     * @see @ref Genlist_Implementation
14758     *
14759     * @ingroup Genlist
14760     */
14761    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
14762    /**
14763     * Get the maximum number of items within an item block
14764     *
14765     * @param obj The genlist object
14766     * @return Maximum number of items within an item block
14767     *
14768     * @see elm_genlist_block_count_set()
14769     *
14770     * @ingroup Genlist
14771     */
14772    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14773    /**
14774     * Set the timeout in seconds for the longpress event.
14775     *
14776     * @param obj The genlist object
14777     * @param timeout timeout in seconds. Default is 1.
14778     *
14779     * This option will change how long it takes to send an event "longpressed"
14780     * after the mouse down signal is sent to the list. If this event occurs, no
14781     * "clicked" event will be sent.
14782     *
14783     * @see elm_genlist_longpress_timeout_set()
14784     *
14785     * @ingroup Genlist
14786     */
14787    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
14788    /**
14789     * Get the timeout in seconds for the longpress event.
14790     *
14791     * @param obj The genlist object
14792     * @return timeout in seconds
14793     *
14794     * @see elm_genlist_longpress_timeout_get()
14795     *
14796     * @ingroup Genlist
14797     */
14798    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14799    /**
14800     * Append a new item in a given genlist widget.
14801     *
14802     * @param obj The genlist object
14803     * @param itc The item class for the item
14804     * @param data The item data
14805     * @param parent The parent item, or NULL if none
14806     * @param flags Item flags
14807     * @param func Convenience function called when the item is selected
14808     * @param func_data Data passed to @p func above.
14809     * @return A handle to the item added or @c NULL if not possible
14810     *
14811     * This adds the given item to the end of the list or the end of
14812     * the children list if the @p parent is given.
14813     *
14814     * @see elm_genlist_item_prepend()
14815     * @see elm_genlist_item_insert_before()
14816     * @see elm_genlist_item_insert_after()
14817     * @see elm_genlist_item_del()
14818     *
14819     * @ingroup Genlist
14820     */
14821    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);
14822    /**
14823     * Prepend a new item in a given genlist widget.
14824     *
14825     * @param obj The genlist object
14826     * @param itc The item class for the item
14827     * @param data The item data
14828     * @param parent The parent item, or NULL if none
14829     * @param flags Item flags
14830     * @param func Convenience function called when the item is selected
14831     * @param func_data Data passed to @p func above.
14832     * @return A handle to the item added or NULL if not possible
14833     *
14834     * This adds an item to the beginning of the list or beginning of the
14835     * children of the parent if given.
14836     *
14837     * @see elm_genlist_item_append()
14838     * @see elm_genlist_item_insert_before()
14839     * @see elm_genlist_item_insert_after()
14840     * @see elm_genlist_item_del()
14841     *
14842     * @ingroup Genlist
14843     */
14844    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);
14845    /**
14846     * Insert an item before another in a genlist widget
14847     *
14848     * @param obj The genlist object
14849     * @param itc The item class for the item
14850     * @param data The item data
14851     * @param before The item to place this new one before.
14852     * @param flags Item flags
14853     * @param func Convenience function called when the item is selected
14854     * @param func_data Data passed to @p func above.
14855     * @return A handle to the item added or @c NULL if not possible
14856     *
14857     * This inserts an item before another in the list. It will be in the
14858     * same tree level or group as the item it is inserted before.
14859     *
14860     * @see elm_genlist_item_append()
14861     * @see elm_genlist_item_prepend()
14862     * @see elm_genlist_item_insert_after()
14863     * @see elm_genlist_item_del()
14864     *
14865     * @ingroup Genlist
14866     */
14867    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);
14868    /**
14869     * Insert an item after another in a genlist widget
14870     *
14871     * @param obj The genlist object
14872     * @param itc The item class for the item
14873     * @param data The item data
14874     * @param after The item to place this new one after.
14875     * @param flags Item flags
14876     * @param func Convenience function called when the item is selected
14877     * @param func_data Data passed to @p func above.
14878     * @return A handle to the item added or @c NULL if not possible
14879     *
14880     * This inserts an item after another in the list. It will be in the
14881     * same tree level or group as the item it is inserted after.
14882     *
14883     * @see elm_genlist_item_append()
14884     * @see elm_genlist_item_prepend()
14885     * @see elm_genlist_item_insert_before()
14886     * @see elm_genlist_item_del()
14887     *
14888     * @ingroup Genlist
14889     */
14890    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);
14891    /**
14892     * Insert a new item into the sorted genlist object
14893     *
14894     * @param obj The genlist object
14895     * @param itc The item class for the item
14896     * @param data The item data
14897     * @param parent The parent item, or NULL if none
14898     * @param flags Item flags
14899     * @param comp The function called for the sort
14900     * @param func Convenience function called when item selected
14901     * @param func_data Data passed to @p func above.
14902     * @return A handle to the item added or NULL if not possible
14903     *
14904     * @ingroup Genlist
14905     */
14906    EAPI Elm_Genlist_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func,const void *func_data);
14907    EAPI Elm_Genlist_Item *elm_genlist_item_direct_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
14908    /* operations to retrieve existing items */
14909    /**
14910     * Get the selectd item in the genlist.
14911     *
14912     * @param obj The genlist object
14913     * @return The selected item, or NULL if none is selected.
14914     *
14915     * This gets the selected item in the list (if multi-selection is enabled, only
14916     * the item that was first selected in the list is returned - which is not very
14917     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
14918     * used).
14919     *
14920     * If no item is selected, NULL is returned.
14921     *
14922     * @see elm_genlist_selected_items_get()
14923     *
14924     * @ingroup Genlist
14925     */
14926    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14927    /**
14928     * Get a list of selected items in the genlist.
14929     *
14930     * @param obj The genlist object
14931     * @return The list of selected items, or NULL if none are selected.
14932     *
14933     * It returns a list of the selected items. This list pointer is only valid so
14934     * long as the selection doesn't change (no items are selected or unselected, or
14935     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
14936     * pointers. The order of the items in this list is the order which they were
14937     * selected, i.e. the first item in this list is the first item that was
14938     * selected, and so on.
14939     *
14940     * @note If not in multi-select mode, consider using function
14941     * elm_genlist_selected_item_get() instead.
14942     *
14943     * @see elm_genlist_multi_select_set()
14944     * @see elm_genlist_selected_item_get()
14945     *
14946     * @ingroup Genlist
14947     */
14948    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14949    /**
14950     * Get a list of realized items in genlist
14951     *
14952     * @param obj The genlist object
14953     * @return The list of realized items, nor NULL if none are realized.
14954     *
14955     * This returns a list of the realized items in the genlist. The list
14956     * contains Elm_Genlist_Item pointers. The list must be freed by the
14957     * caller when done with eina_list_free(). The item pointers in the
14958     * list are only valid so long as those items are not deleted or the
14959     * genlist is not deleted.
14960     *
14961     * @see elm_genlist_realized_items_update()
14962     *
14963     * @ingroup Genlist
14964     */
14965    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14966    /**
14967     * Get the item that is at the x, y canvas coords.
14968     *
14969     * @param obj The gelinst object.
14970     * @param x The input x coordinate
14971     * @param y The input y coordinate
14972     * @param posret The position relative to the item returned here
14973     * @return The item at the coordinates or NULL if none
14974     *
14975     * This returns the item at the given coordinates (which are canvas
14976     * relative, not object-relative). If an item is at that coordinate,
14977     * that item handle is returned, and if @p posret is not NULL, the
14978     * integer pointed to is set to a value of -1, 0 or 1, depending if
14979     * the coordinate is on the upper portion of that item (-1), on the
14980     * middle section (0) or on the lower part (1). If NULL is returned as
14981     * an item (no item found there), then posret may indicate -1 or 1
14982     * based if the coordinate is above or below all items respectively in
14983     * the genlist.
14984     *
14985     * @ingroup Genlist
14986     */
14987    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);
14988    /**
14989     * Get the first item in the genlist
14990     *
14991     * This returns the first item in the list.
14992     *
14993     * @param obj The genlist object
14994     * @return The first item, or NULL if none
14995     *
14996     * @ingroup Genlist
14997     */
14998    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14999    /**
15000     * Get the last item in the genlist
15001     *
15002     * This returns the last item in the list.
15003     *
15004     * @return The last item, or NULL if none
15005     *
15006     * @ingroup Genlist
15007     */
15008    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15009    /**
15010     * Set the scrollbar policy
15011     *
15012     * @param obj The genlist object
15013     * @param policy_h Horizontal scrollbar policy.
15014     * @param policy_v Vertical scrollbar policy.
15015     *
15016     * This sets the scrollbar visibility policy for the given genlist
15017     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15018     * made visible if it is needed, and otherwise kept hidden.
15019     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15020     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15021     * respectively for the horizontal and vertical scrollbars. Default is
15022     * #ELM_SMART_SCROLLER_POLICY_AUTO
15023     *
15024     * @see elm_genlist_scroller_policy_get()
15025     *
15026     * @ingroup Genlist
15027     */
15028    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15029    /**
15030     * Get the scrollbar policy
15031     *
15032     * @param obj The genlist object
15033     * @param policy_h Pointer to store the horizontal scrollbar policy.
15034     * @param policy_v Pointer to store the vertical scrollbar policy.
15035     *
15036     * @see elm_genlist_scroller_policy_set()
15037     *
15038     * @ingroup Genlist
15039     */
15040    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);
15041    /**
15042     * Get the @b next item in a genlist widget's internal list of items,
15043     * given a handle to one of those items.
15044     *
15045     * @param item The genlist item to fetch next from
15046     * @return The item after @p item, or @c NULL if there's none (and
15047     * on errors)
15048     *
15049     * This returns the item placed after the @p item, on the container
15050     * genlist.
15051     *
15052     * @see elm_genlist_item_prev_get()
15053     *
15054     * @ingroup Genlist
15055     */
15056    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15057    /**
15058     * Get the @b previous item in a genlist widget's internal list of items,
15059     * given a handle to one of those items.
15060     *
15061     * @param item The genlist item to fetch previous from
15062     * @return The item before @p item, or @c NULL if there's none (and
15063     * on errors)
15064     *
15065     * This returns the item placed before the @p item, on the container
15066     * genlist.
15067     *
15068     * @see elm_genlist_item_next_get()
15069     *
15070     * @ingroup Genlist
15071     */
15072    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15073    /**
15074     * Get the genlist object's handle which contains a given genlist
15075     * item
15076     *
15077     * @param item The item to fetch the container from
15078     * @return The genlist (parent) object
15079     *
15080     * This returns the genlist object itself that an item belongs to.
15081     *
15082     * @ingroup Genlist
15083     */
15084    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15085    /**
15086     * Get the parent item of the given item
15087     *
15088     * @param it The item
15089     * @return The parent of the item or @c NULL if it has no parent.
15090     *
15091     * This returns the item that was specified as parent of the item @p it on
15092     * elm_genlist_item_append() and insertion related functions.
15093     *
15094     * @ingroup Genlist
15095     */
15096    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15097    /**
15098     * Remove all sub-items (children) of the given item
15099     *
15100     * @param it The item
15101     *
15102     * This removes all items that are children (and their descendants) of the
15103     * given item @p it.
15104     *
15105     * @see elm_genlist_clear()
15106     * @see elm_genlist_item_del()
15107     *
15108     * @ingroup Genlist
15109     */
15110    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15111    /**
15112     * Set whether a given genlist item is selected or not
15113     *
15114     * @param it The item
15115     * @param selected Use @c EINA_TRUE, to make it selected, @c
15116     * EINA_FALSE to make it unselected
15117     *
15118     * This sets the selected state of an item. If multi selection is
15119     * not enabled on the containing genlist and @p selected is @c
15120     * EINA_TRUE, any other previously selected items will get
15121     * unselected in favor of this new one.
15122     *
15123     * @see elm_genlist_item_selected_get()
15124     *
15125     * @ingroup Genlist
15126     */
15127    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15128    /**
15129     * Get whether a given genlist item is selected or not
15130     *
15131     * @param it The item
15132     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15133     *
15134     * @see elm_genlist_item_selected_set() for more details
15135     *
15136     * @ingroup Genlist
15137     */
15138    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15139    /**
15140     * Sets the expanded state of an item.
15141     *
15142     * @param it The item
15143     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15144     *
15145     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15146     * expanded or not.
15147     *
15148     * The theme will respond to this change visually, and a signal "expanded" or
15149     * "contracted" will be sent from the genlist with a pointer to the item that
15150     * has been expanded/contracted.
15151     *
15152     * Calling this function won't show or hide any child of this item (if it is
15153     * a parent). You must manually delete and create them on the callbacks fo
15154     * the "expanded" or "contracted" signals.
15155     *
15156     * @see elm_genlist_item_expanded_get()
15157     *
15158     * @ingroup Genlist
15159     */
15160    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15161    /**
15162     * Get the expanded state of an item
15163     *
15164     * @param it The item
15165     * @return The expanded state
15166     *
15167     * This gets the expanded state of an item.
15168     *
15169     * @see elm_genlist_item_expanded_set()
15170     *
15171     * @ingroup Genlist
15172     */
15173    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15174    /**
15175     * Get the depth of expanded item
15176     *
15177     * @param it The genlist item object
15178     * @return The depth of expanded item
15179     *
15180     * @ingroup Genlist
15181     */
15182    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15183    /**
15184     * Set whether a given genlist item is disabled or not.
15185     *
15186     * @param it The item
15187     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15188     * to enable it back.
15189     *
15190     * A disabled item cannot be selected or unselected. It will also
15191     * change its appearance, to signal the user it's disabled.
15192     *
15193     * @see elm_genlist_item_disabled_get()
15194     *
15195     * @ingroup Genlist
15196     */
15197    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15198    /**
15199     * Get whether a given genlist item is disabled or not.
15200     *
15201     * @param it The item
15202     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15203     * (and on errors).
15204     *
15205     * @see elm_genlist_item_disabled_set() for more details
15206     *
15207     * @ingroup Genlist
15208     */
15209    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15210    /**
15211     * Sets the display only state of an item.
15212     *
15213     * @param it The item
15214     * @param display_only @c EINA_TRUE if the item is display only, @c
15215     * EINA_FALSE otherwise.
15216     *
15217     * A display only item cannot be selected or unselected. It is for
15218     * display only and not selecting or otherwise clicking, dragging
15219     * etc. by the user, thus finger size rules will not be applied to
15220     * this item.
15221     *
15222     * It's good to set group index items to display only state.
15223     *
15224     * @see elm_genlist_item_display_only_get()
15225     *
15226     * @ingroup Genlist
15227     */
15228    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15229    /**
15230     * Get the display only state of an item
15231     *
15232     * @param it The item
15233     * @return @c EINA_TRUE if the item is display only, @c
15234     * EINA_FALSE otherwise.
15235     *
15236     * @see elm_genlist_item_display_only_set()
15237     *
15238     * @ingroup Genlist
15239     */
15240    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15241    /**
15242     * Show the portion of a genlist's internal list containing a given
15243     * item, immediately.
15244     *
15245     * @param it The item to display
15246     *
15247     * This causes genlist to jump to the given item @p it and show it (by
15248     * immediately scrolling to that position), if it is not fully visible.
15249     *
15250     * @see elm_genlist_item_bring_in()
15251     * @see elm_genlist_item_top_show()
15252     * @see elm_genlist_item_middle_show()
15253     *
15254     * @ingroup Genlist
15255     */
15256    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15257    /**
15258     * Animatedly bring in, to the visible are of a genlist, a given
15259     * item on it.
15260     *
15261     * @param it The item to display
15262     *
15263     * This causes genlist to jump to the given item @p it and show it (by
15264     * animatedly scrolling), if it is not fully visible. This may use animation
15265     * to do so and take a period of time
15266     *
15267     * @see elm_genlist_item_show()
15268     * @see elm_genlist_item_top_bring_in()
15269     * @see elm_genlist_item_middle_bring_in()
15270     *
15271     * @ingroup Genlist
15272     */
15273    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15274    /**
15275     * Show the portion of a genlist's internal list containing a given
15276     * item, immediately.
15277     *
15278     * @param it The item to display
15279     *
15280     * This causes genlist to jump to the given item @p it and show it (by
15281     * immediately scrolling to that position), if it is not fully visible.
15282     *
15283     * The item will be positioned at the top of the genlist viewport.
15284     *
15285     * @see elm_genlist_item_show()
15286     * @see elm_genlist_item_top_bring_in()
15287     *
15288     * @ingroup Genlist
15289     */
15290    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15291    /**
15292     * Animatedly bring in, to the visible are of a genlist, a given
15293     * item on it.
15294     *
15295     * @param it The item
15296     *
15297     * This causes genlist to jump to the given item @p it and show it (by
15298     * animatedly scrolling), if it is not fully visible. This may use animation
15299     * to do so and take a period of time
15300     *
15301     * The item will be positioned at the top of the genlist viewport.
15302     *
15303     * @see elm_genlist_item_bring_in()
15304     * @see elm_genlist_item_top_show()
15305     *
15306     * @ingroup Genlist
15307     */
15308    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15309    /**
15310     * Show the portion of a genlist's internal list containing a given
15311     * item, immediately.
15312     *
15313     * @param it The item to display
15314     *
15315     * This causes genlist to jump to the given item @p it and show it (by
15316     * immediately scrolling to that position), if it is not fully visible.
15317     *
15318     * The item will be positioned at the middle of the genlist viewport.
15319     *
15320     * @see elm_genlist_item_show()
15321     * @see elm_genlist_item_middle_bring_in()
15322     *
15323     * @ingroup Genlist
15324     */
15325    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15326    /**
15327     * Animatedly bring in, to the visible are of a genlist, a given
15328     * item on it.
15329     *
15330     * @param it The item
15331     *
15332     * This causes genlist to jump to the given item @p it and show it (by
15333     * animatedly scrolling), if it is not fully visible. This may use animation
15334     * to do so and take a period of time
15335     *
15336     * The item will be positioned at the middle of the genlist viewport.
15337     *
15338     * @see elm_genlist_item_bring_in()
15339     * @see elm_genlist_item_middle_show()
15340     *
15341     * @ingroup Genlist
15342     */
15343    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15344    /**
15345     * Remove a genlist item from the its parent, deleting it.
15346     *
15347     * @param item The item to be removed.
15348     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15349     *
15350     * @see elm_genlist_clear(), to remove all items in a genlist at
15351     * once.
15352     *
15353     * @ingroup Genlist
15354     */
15355    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15356    /**
15357     * Return the data associated to a given genlist item
15358     *
15359     * @param item The genlist item.
15360     * @return the data associated to this item.
15361     *
15362     * This returns the @c data value passed on the
15363     * elm_genlist_item_append() and related item addition calls.
15364     *
15365     * @see elm_genlist_item_append()
15366     * @see elm_genlist_item_data_set()
15367     *
15368     * @ingroup Genlist
15369     */
15370    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15371    /**
15372     * Set the data associated to a given genlist item
15373     *
15374     * @param item The genlist item
15375     * @param data The new data pointer to set on it
15376     *
15377     * This @b overrides the @c data value passed on the
15378     * elm_genlist_item_append() and related item addition calls. This
15379     * function @b won't call elm_genlist_item_update() automatically,
15380     * so you'd issue it afterwards if you want to hove the item
15381     * updated to reflect the that new data.
15382     *
15383     * @see elm_genlist_item_data_get()
15384     *
15385     * @ingroup Genlist
15386     */
15387    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15388    /**
15389     * Tells genlist to "orphan" icons fetchs by the item class
15390     *
15391     * @param it The item
15392     *
15393     * This instructs genlist to release references to icons in the item,
15394     * meaning that they will no longer be managed by genlist and are
15395     * floating "orphans" that can be re-used elsewhere if the user wants
15396     * to.
15397     *
15398     * @ingroup Genlist
15399     */
15400    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15401    /**
15402     * Get the real Evas object created to implement the view of a
15403     * given genlist item
15404     *
15405     * @param item The genlist item.
15406     * @return the Evas object implementing this item's view.
15407     *
15408     * This returns the actual Evas object used to implement the
15409     * specified genlist item's view. This may be @c NULL, as it may
15410     * not have been created or may have been deleted, at any time, by
15411     * the genlist. <b>Do not modify this object</b> (move, resize,
15412     * show, hide, etc.), as the genlist is controlling it. This
15413     * function is for querying, emitting custom signals or hooking
15414     * lower level callbacks for events on that object. Do not delete
15415     * this object under any circumstances.
15416     *
15417     * @see elm_genlist_item_data_get()
15418     *
15419     * @ingroup Genlist
15420     */
15421    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15422    /**
15423     * Update the contents of an item
15424     *
15425     * @param it The item
15426     *
15427     * This updates an item by calling all the item class functions again
15428     * to get the icons, labels and states. Use this when the original
15429     * item data has changed and the changes are desired to be reflected.
15430     *
15431     * Use elm_genlist_realized_items_update() to update all already realized
15432     * items.
15433     *
15434     * @see elm_genlist_realized_items_update()
15435     *
15436     * @ingroup Genlist
15437     */
15438    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15439    /**
15440     * Update the item class of an item
15441     *
15442     * @param it The item
15443     * @param itc The item class for the item
15444     *
15445     * This sets another class fo the item, changing the way that it is
15446     * displayed. After changing the item class, elm_genlist_item_update() is
15447     * called on the item @p it.
15448     *
15449     * @ingroup Genlist
15450     */
15451    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15452    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15453    /**
15454     * Set the text to be shown in a given genlist item's tooltips.
15455     *
15456     * @param item The genlist item
15457     * @param text The text to set in the content
15458     *
15459     * This call will setup the text to be used as tooltip to that item
15460     * (analogous to elm_object_tooltip_text_set(), but being item
15461     * tooltips with higher precedence than object tooltips). It can
15462     * have only one tooltip at a time, so any previous tooltip data
15463     * will get removed.
15464     *
15465     * In order to set an icon or something else as a tooltip, look at
15466     * elm_genlist_item_tooltip_content_cb_set().
15467     *
15468     * @ingroup Genlist
15469     */
15470    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15471    /**
15472     * Set the content to be shown in a given genlist item's tooltips
15473     *
15474     * @param item The genlist item.
15475     * @param func The function returning the tooltip contents.
15476     * @param data What to provide to @a func as callback data/context.
15477     * @param del_cb Called when data is not needed anymore, either when
15478     *        another callback replaces @p func, the tooltip is unset with
15479     *        elm_genlist_item_tooltip_unset() or the owner @p item
15480     *        dies. This callback receives as its first parameter the
15481     *        given @p data, being @c event_info the item handle.
15482     *
15483     * This call will setup the tooltip's contents to @p item
15484     * (analogous to elm_object_tooltip_content_cb_set(), but being
15485     * item tooltips with higher precedence than object tooltips). It
15486     * can have only one tooltip at a time, so any previous tooltip
15487     * content will get removed. @p func (with @p data) will be called
15488     * every time Elementary needs to show the tooltip and it should
15489     * return a valid Evas object, which will be fully managed by the
15490     * tooltip system, getting deleted when the tooltip is gone.
15491     *
15492     * In order to set just a text as a tooltip, look at
15493     * elm_genlist_item_tooltip_text_set().
15494     *
15495     * @ingroup Genlist
15496     */
15497    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);
15498    /**
15499     * Unset a tooltip from a given genlist item
15500     *
15501     * @param item genlist item to remove a previously set tooltip from.
15502     *
15503     * This call removes any tooltip set on @p item. The callback
15504     * provided as @c del_cb to
15505     * elm_genlist_item_tooltip_content_cb_set() will be called to
15506     * notify it is not used anymore (and have resources cleaned, if
15507     * need be).
15508     *
15509     * @see elm_genlist_item_tooltip_content_cb_set()
15510     *
15511     * @ingroup Genlist
15512     */
15513    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15514    /**
15515     * Set a different @b style for a given genlist item's tooltip.
15516     *
15517     * @param item genlist item with tooltip set
15518     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15519     * "default", @c "transparent", etc)
15520     *
15521     * Tooltips can have <b>alternate styles</b> to be displayed on,
15522     * which are defined by the theme set on Elementary. This function
15523     * works analogously as elm_object_tooltip_style_set(), but here
15524     * applied only to genlist item objects. The default style for
15525     * tooltips is @c "default".
15526     *
15527     * @note before you set a style you should define a tooltip with
15528     *       elm_genlist_item_tooltip_content_cb_set() or
15529     *       elm_genlist_item_tooltip_text_set()
15530     *
15531     * @see elm_genlist_item_tooltip_style_get()
15532     *
15533     * @ingroup Genlist
15534     */
15535    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15536    /**
15537     * Get the style set a given genlist item's tooltip.
15538     *
15539     * @param item genlist item with tooltip already set on.
15540     * @return style the theme style in use, which defaults to
15541     *         "default". If the object does not have a tooltip set,
15542     *         then @c NULL is returned.
15543     *
15544     * @see elm_genlist_item_tooltip_style_set() for more details
15545     *
15546     * @ingroup Genlist
15547     */
15548    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15549    /**
15550     * @brief Disable size restrictions on an object's tooltip
15551     * @param item The tooltip's anchor object
15552     * @param disable If EINA_TRUE, size restrictions are disabled
15553     * @return EINA_FALSE on failure, EINA_TRUE on success
15554     *
15555     * This function allows a tooltip to expand beyond its parant window's canvas.
15556     * It will instead be limited only by the size of the display.
15557     */
15558    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15559    /**
15560     * @brief Retrieve size restriction state of an object's tooltip
15561     * @param item The tooltip's anchor object
15562     * @return If EINA_TRUE, size restrictions are disabled
15563     *
15564     * This function returns whether a tooltip is allowed to expand beyond
15565     * its parant window's canvas.
15566     * It will instead be limited only by the size of the display.
15567     */
15568    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15569    /**
15570     * Set the type of mouse pointer/cursor decoration to be shown,
15571     * when the mouse pointer is over the given genlist widget item
15572     *
15573     * @param item genlist item to customize cursor on
15574     * @param cursor the cursor type's name
15575     *
15576     * This function works analogously as elm_object_cursor_set(), but
15577     * here the cursor's changing area is restricted to the item's
15578     * area, and not the whole widget's. Note that that item cursors
15579     * have precedence over widget cursors, so that a mouse over @p
15580     * item will always show cursor @p type.
15581     *
15582     * If this function is called twice for an object, a previously set
15583     * cursor will be unset on the second call.
15584     *
15585     * @see elm_object_cursor_set()
15586     * @see elm_genlist_item_cursor_get()
15587     * @see elm_genlist_item_cursor_unset()
15588     *
15589     * @ingroup Genlist
15590     */
15591    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15592    /**
15593     * Get the type of mouse pointer/cursor decoration set to be shown,
15594     * when the mouse pointer is over the given genlist widget item
15595     *
15596     * @param item genlist item with custom cursor set
15597     * @return the cursor type's name or @c NULL, if no custom cursors
15598     * were set to @p item (and on errors)
15599     *
15600     * @see elm_object_cursor_get()
15601     * @see elm_genlist_item_cursor_set() for more details
15602     * @see elm_genlist_item_cursor_unset()
15603     *
15604     * @ingroup Genlist
15605     */
15606    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15607    /**
15608     * Unset any custom mouse pointer/cursor decoration set to be
15609     * shown, when the mouse pointer is over the given genlist widget
15610     * item, thus making it show the @b default cursor again.
15611     *
15612     * @param item a genlist item
15613     *
15614     * Use this call to undo any custom settings on this item's cursor
15615     * decoration, bringing it back to defaults (no custom style set).
15616     *
15617     * @see elm_object_cursor_unset()
15618     * @see elm_genlist_item_cursor_set() for more details
15619     *
15620     * @ingroup Genlist
15621     */
15622    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15623    /**
15624     * Set a different @b style for a given custom cursor set for a
15625     * genlist item.
15626     *
15627     * @param item genlist item with custom cursor set
15628     * @param style the <b>theme style</b> to use (e.g. @c "default",
15629     * @c "transparent", etc)
15630     *
15631     * This function only makes sense when one is using custom mouse
15632     * cursor decorations <b>defined in a theme file</b> , which can
15633     * have, given a cursor name/type, <b>alternate styles</b> on
15634     * it. It works analogously as elm_object_cursor_style_set(), but
15635     * here applied only to genlist item objects.
15636     *
15637     * @warning Before you set a cursor style you should have defined a
15638     *       custom cursor previously on the item, with
15639     *       elm_genlist_item_cursor_set()
15640     *
15641     * @see elm_genlist_item_cursor_engine_only_set()
15642     * @see elm_genlist_item_cursor_style_get()
15643     *
15644     * @ingroup Genlist
15645     */
15646    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15647    /**
15648     * Get the current @b style set for a given genlist item's custom
15649     * cursor
15650     *
15651     * @param item genlist item with custom cursor set.
15652     * @return style the cursor style in use. If the object does not
15653     *         have a cursor set, then @c NULL is returned.
15654     *
15655     * @see elm_genlist_item_cursor_style_set() for more details
15656     *
15657     * @ingroup Genlist
15658     */
15659    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15660    /**
15661     * Set if the (custom) cursor for a given genlist item should be
15662     * searched in its theme, also, or should only rely on the
15663     * rendering engine.
15664     *
15665     * @param item item with custom (custom) cursor already set on
15666     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15667     * only on those provided by the rendering engine, @c EINA_FALSE to
15668     * have them searched on the widget's theme, as well.
15669     *
15670     * @note This call is of use only if you've set a custom cursor
15671     * for genlist items, with elm_genlist_item_cursor_set().
15672     *
15673     * @note By default, cursors will only be looked for between those
15674     * provided by the rendering engine.
15675     *
15676     * @ingroup Genlist
15677     */
15678    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15679    /**
15680     * Get if the (custom) cursor for a given genlist item is being
15681     * searched in its theme, also, or is only relying on the rendering
15682     * engine.
15683     *
15684     * @param item a genlist item
15685     * @return @c EINA_TRUE, if cursors are being looked for only on
15686     * those provided by the rendering engine, @c EINA_FALSE if they
15687     * are being searched on the widget's theme, as well.
15688     *
15689     * @see elm_genlist_item_cursor_engine_only_set(), for more details
15690     *
15691     * @ingroup Genlist
15692     */
15693    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15694    /**
15695     * Update the contents of all realized items.
15696     *
15697     * @param obj The genlist object.
15698     *
15699     * This updates all realized items by calling all the item class functions again
15700     * to get the icons, labels and states. Use this when the original
15701     * item data has changed and the changes are desired to be reflected.
15702     *
15703     * To update just one item, use elm_genlist_item_update().
15704     *
15705     * @see elm_genlist_realized_items_get()
15706     * @see elm_genlist_item_update()
15707     *
15708     * @ingroup Genlist
15709     */
15710    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15711    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
15712    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15713    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15714    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
15715    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15716
15717    /**
15718     * @}
15719     */
15720
15721    /**
15722     * @defgroup Check Check
15723     *
15724     * @image html img/widget/check/preview-00.png
15725     * @image latex img/widget/check/preview-00.eps
15726     * @image html img/widget/check/preview-01.png
15727     * @image latex img/widget/check/preview-01.eps
15728     * @image html img/widget/check/preview-02.png
15729     * @image latex img/widget/check/preview-02.eps
15730     *
15731     * @brief The check widget allows for toggling a value between true and
15732     * false.
15733     *
15734     * Check objects are a lot like radio objects in layout and functionality
15735     * except they do not work as a group, but independently and only toggle the
15736     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
15737     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
15738     * returns the current state. For convenience, like the radio objects, you
15739     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
15740     * for it to modify.
15741     *
15742     * Signals that you can add callbacks for are:
15743     * "changed" - This is called whenever the user changes the state of one of
15744     *             the check object(event_info is NULL).
15745     *
15746     * @ref tutorial_check should give you a firm grasp of how to use this widget.
15747     * @{
15748     */
15749    /**
15750     * @brief Add a new Check object
15751     *
15752     * @param parent The parent object
15753     * @return The new object or NULL if it cannot be created
15754     */
15755    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15756    /**
15757     * @brief Set the text label of the check object
15758     *
15759     * @param obj The check object
15760     * @param label The text label string in UTF-8
15761     *
15762     * @deprecated use elm_object_text_set() instead.
15763     */
15764    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15765    /**
15766     * @brief Get the text label of the check object
15767     *
15768     * @param obj The check object
15769     * @return The text label string in UTF-8
15770     *
15771     * @deprecated use elm_object_text_get() instead.
15772     */
15773    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15774    /**
15775     * @brief Set the icon object of the check object
15776     *
15777     * @param obj The check object
15778     * @param icon The icon object
15779     *
15780     * Once the icon object is set, a previously set one will be deleted.
15781     * If you want to keep that old content object, use the
15782     * elm_check_icon_unset() function.
15783     */
15784    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15785    /**
15786     * @brief Get the icon object of the check object
15787     *
15788     * @param obj The check object
15789     * @return The icon object
15790     */
15791    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15792    /**
15793     * @brief Unset the icon used for the check object
15794     *
15795     * @param obj The check object
15796     * @return The icon object that was being used
15797     *
15798     * Unparent and return the icon object which was set for this widget.
15799     */
15800    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15801    /**
15802     * @brief Set the on/off state of the check object
15803     *
15804     * @param obj The check object
15805     * @param state The state to use (1 == on, 0 == off)
15806     *
15807     * This sets the state of the check. If set
15808     * with elm_check_state_pointer_set() the state of that variable is also
15809     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
15810     */
15811    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
15812    /**
15813     * @brief Get the state of the check object
15814     *
15815     * @param obj The check object
15816     * @return The boolean state
15817     */
15818    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15819    /**
15820     * @brief Set a convenience pointer to a boolean to change
15821     *
15822     * @param obj The check object
15823     * @param statep Pointer to the boolean to modify
15824     *
15825     * This sets a pointer to a boolean, that, in addition to the check objects
15826     * state will also be modified directly. To stop setting the object pointed
15827     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
15828     * then when this is called, the check objects state will also be modified to
15829     * reflect the value of the boolean @p statep points to, just like calling
15830     * elm_check_state_set().
15831     */
15832    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
15833    /**
15834     * @}
15835     */
15836
15837    /**
15838     * @defgroup Radio Radio
15839     *
15840     * @image html img/widget/radio/preview-00.png
15841     * @image latex img/widget/radio/preview-00.eps
15842     *
15843     * @brief Radio is a widget that allows for 1 or more options to be displayed
15844     * and have the user choose only 1 of them.
15845     *
15846     * A radio object contains an indicator, an optional Label and an optional
15847     * icon object. While it's possible to have a group of only one radio they,
15848     * are normally used in groups of 2 or more. To add a radio to a group use
15849     * elm_radio_group_add(). The radio object(s) will select from one of a set
15850     * of integer values, so any value they are configuring needs to be mapped to
15851     * a set of integers. To configure what value that radio object represents,
15852     * use  elm_radio_state_value_set() to set the integer it represents. To set
15853     * the value the whole group(which one is currently selected) is to indicate
15854     * use elm_radio_value_set() on any group member, and to get the groups value
15855     * use elm_radio_value_get(). For convenience the radio objects are also able
15856     * to directly set an integer(int) to the value that is selected. To specify
15857     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
15858     * The radio objects will modify this directly. That implies the pointer must
15859     * point to valid memory for as long as the radio objects exist.
15860     *
15861     * Signals that you can add callbacks for are:
15862     * @li changed - This is called whenever the user changes the state of one of
15863     * the radio objects within the group of radio objects that work together.
15864     *
15865     * @ref tutorial_radio show most of this API in action.
15866     * @{
15867     */
15868    /**
15869     * @brief Add a new radio to the parent
15870     *
15871     * @param parent The parent object
15872     * @return The new object or NULL if it cannot be created
15873     */
15874    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15875    /**
15876     * @brief Set the text label of the radio object
15877     *
15878     * @param obj The radio object
15879     * @param label The text label string in UTF-8
15880     *
15881     * @deprecated use elm_object_text_set() instead.
15882     */
15883    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15884    /**
15885     * @brief Get the text label of the radio object
15886     *
15887     * @param obj The radio object
15888     * @return The text label string in UTF-8
15889     *
15890     * @deprecated use elm_object_text_set() instead.
15891     */
15892    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15893    /**
15894     * @brief Set the icon object of the radio object
15895     *
15896     * @param obj The radio object
15897     * @param icon The icon object
15898     *
15899     * Once the icon object is set, a previously set one will be deleted. If you
15900     * want to keep that old content object, use the elm_radio_icon_unset()
15901     * function.
15902     */
15903    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15904    /**
15905     * @brief Get the icon object of the radio object
15906     *
15907     * @param obj The radio object
15908     * @return The icon object
15909     *
15910     * @see elm_radio_icon_set()
15911     */
15912    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15913    /**
15914     * @brief Unset the icon used for the radio object
15915     *
15916     * @param obj The radio object
15917     * @return The icon object that was being used
15918     *
15919     * Unparent and return the icon object which was set for this widget.
15920     *
15921     * @see elm_radio_icon_set()
15922     */
15923    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15924    /**
15925     * @brief Add this radio to a group of other radio objects
15926     *
15927     * @param obj The radio object
15928     * @param group Any object whose group the @p obj is to join.
15929     *
15930     * Radio objects work in groups. Each member should have a different integer
15931     * value assigned. In order to have them work as a group, they need to know
15932     * about each other. This adds the given radio object to the group of which
15933     * the group object indicated is a member.
15934     */
15935    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
15936    /**
15937     * @brief Set the integer value that this radio object represents
15938     *
15939     * @param obj The radio object
15940     * @param value The value to use if this radio object is selected
15941     *
15942     * This sets the value of the radio.
15943     */
15944    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
15945    /**
15946     * @brief Get the integer value that this radio object represents
15947     *
15948     * @param obj The radio object
15949     * @return The value used if this radio object is selected
15950     *
15951     * This gets the value of the radio.
15952     *
15953     * @see elm_radio_value_set()
15954     */
15955    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15956    /**
15957     * @brief Set the value of the radio.
15958     *
15959     * @param obj The radio object
15960     * @param value The value to use for the group
15961     *
15962     * This sets the value of the radio group and will also set the value if
15963     * pointed to, to the value supplied, but will not call any callbacks.
15964     */
15965    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
15966    /**
15967     * @brief Get the state of the radio object
15968     *
15969     * @param obj The radio object
15970     * @return The integer state
15971     */
15972    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15973    /**
15974     * @brief Set a convenience pointer to a integer to change
15975     *
15976     * @param obj The radio object
15977     * @param valuep Pointer to the integer to modify
15978     *
15979     * This sets a pointer to a integer, that, in addition to the radio objects
15980     * state will also be modified directly. To stop setting the object pointed
15981     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
15982     * when this is called, the radio objects state will also be modified to
15983     * reflect the value of the integer valuep points to, just like calling
15984     * elm_radio_value_set().
15985     */
15986    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
15987    /**
15988     * @}
15989     */
15990
15991    /**
15992     * @defgroup Pager Pager
15993     *
15994     * @image html img/widget/pager/preview-00.png
15995     * @image latex img/widget/pager/preview-00.eps
15996     *
15997     * @brief Widget that allows flipping between 1 or more “pages” of objects.
15998     *
15999     * The flipping between “pages” of objects is animated. All content in pager
16000     * is kept in a stack, the last content to be added will be on the top of the
16001     * stack(be visible).
16002     *
16003     * Objects can be pushed or popped from the stack or deleted as normal.
16004     * Pushes and pops will animate (and a pop will delete the object once the
16005     * animation is finished). Any object already in the pager can be promoted to
16006     * the top(from its current stacking position) through the use of
16007     * elm_pager_content_promote(). Objects are pushed to the top with
16008     * elm_pager_content_push() and when the top item is no longer wanted, simply
16009     * pop it with elm_pager_content_pop() and it will also be deleted. If an
16010     * object is no longer needed and is not the top item, just delete it as
16011     * normal. You can query which objects are the top and bottom with
16012     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16013     *
16014     * Signals that you can add callbacks for are:
16015     * "hide,finished" - when the previous page is hided
16016     *
16017     * This widget has the following styles available:
16018     * @li default
16019     * @li fade
16020     * @li fade_translucide
16021     * @li fade_invisible
16022     * @note This styles affect only the flipping animations, the appearance when
16023     * not animating is unaffected by styles.
16024     *
16025     * @ref tutorial_pager gives a good overview of the usage of the API.
16026     * @{
16027     */
16028    /**
16029     * Add a new pager to the parent
16030     *
16031     * @param parent The parent object
16032     * @return The new object or NULL if it cannot be created
16033     *
16034     * @ingroup Pager
16035     */
16036    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16037    /**
16038     * @brief Push an object to the top of the pager stack (and show it).
16039     *
16040     * @param obj The pager object
16041     * @param content The object to push
16042     *
16043     * The object pushed becomes a child of the pager, it will be controlled and
16044     * deleted when the pager is deleted.
16045     *
16046     * @note If the content is already in the stack use
16047     * elm_pager_content_promote().
16048     * @warning Using this function on @p content already in the stack results in
16049     * undefined behavior.
16050     */
16051    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16052    /**
16053     * @brief Pop the object that is on top of the stack
16054     *
16055     * @param obj The pager object
16056     *
16057     * This pops the object that is on the top(visible) of the pager, makes it
16058     * disappear, then deletes the object. The object that was underneath it on
16059     * the stack will become visible.
16060     */
16061    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16062    /**
16063     * @brief Moves an object already in the pager stack to the top of the stack.
16064     *
16065     * @param obj The pager object
16066     * @param content The object to promote
16067     *
16068     * This will take the @p content and move it to the top of the stack as
16069     * if it had been pushed there.
16070     *
16071     * @note If the content isn't already in the stack use
16072     * elm_pager_content_push().
16073     * @warning Using this function on @p content not already in the stack
16074     * results in undefined behavior.
16075     */
16076    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16077    /**
16078     * @brief Return the object at the bottom of the pager stack
16079     *
16080     * @param obj The pager object
16081     * @return The bottom object or NULL if none
16082     */
16083    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16084    /**
16085     * @brief  Return the object at the top of the pager stack
16086     *
16087     * @param obj The pager object
16088     * @return The top object or NULL if none
16089     */
16090    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16091    /**
16092     * @}
16093     */
16094
16095    /**
16096     * @defgroup Slideshow Slideshow
16097     *
16098     * @image html img/widget/slideshow/preview-00.png
16099     * @image latex img/widget/slideshow/preview-00.eps
16100     *
16101     * This widget, as the name indicates, is a pre-made image
16102     * slideshow panel, with API functions acting on (child) image
16103     * items presentation. Between those actions, are:
16104     * - advance to next/previous image
16105     * - select the style of image transition animation
16106     * - set the exhibition time for each image
16107     * - start/stop the slideshow
16108     *
16109     * The transition animations are defined in the widget's theme,
16110     * consequently new animations can be added without having to
16111     * update the widget's code.
16112     *
16113     * @section Slideshow_Items Slideshow items
16114     *
16115     * For slideshow items, just like for @ref Genlist "genlist" ones,
16116     * the user defines a @b classes, specifying functions that will be
16117     * called on the item's creation and deletion times.
16118     *
16119     * The #Elm_Slideshow_Item_Class structure contains the following
16120     * members:
16121     *
16122     * - @c func.get - When an item is displayed, this function is
16123     *   called, and it's where one should create the item object, de
16124     *   facto. For example, the object can be a pure Evas image object
16125     *   or an Elementary @ref Photocam "photocam" widget. See
16126     *   #SlideshowItemGetFunc.
16127     * - @c func.del - When an item is no more displayed, this function
16128     *   is called, where the user must delete any data associated to
16129     *   the item. See #SlideshowItemDelFunc.
16130     *
16131     * @section Slideshow_Caching Slideshow caching
16132     *
16133     * The slideshow provides facilities to have items adjacent to the
16134     * one being displayed <b>already "realized"</b> (i.e. loaded) for
16135     * you, so that the system does not have to decode image data
16136     * anymore at the time it has to actually switch images on its
16137     * viewport. The user is able to set the numbers of items to be
16138     * cached @b before and @b after the current item, in the widget's
16139     * item list.
16140     *
16141     * Smart events one can add callbacks for are:
16142     *
16143     * - @c "changed" - when the slideshow switches its view to a new
16144     *   item
16145     *
16146     * List of examples for the slideshow widget:
16147     * @li @ref slideshow_example
16148     */
16149
16150    /**
16151     * @addtogroup Slideshow
16152     * @{
16153     */
16154
16155    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16156    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16157    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
16158    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16159    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16160
16161    /**
16162     * @struct _Elm_Slideshow_Item_Class
16163     *
16164     * Slideshow item class definition. See @ref Slideshow_Items for
16165     * field details.
16166     */
16167    struct _Elm_Slideshow_Item_Class
16168      {
16169         struct _Elm_Slideshow_Item_Class_Func
16170           {
16171              SlideshowItemGetFunc get;
16172              SlideshowItemDelFunc del;
16173           } func;
16174      }; /**< #Elm_Slideshow_Item_Class member definitions */
16175
16176    /**
16177     * Add a new slideshow widget to the given parent Elementary
16178     * (container) object
16179     *
16180     * @param parent The parent object
16181     * @return A new slideshow widget handle or @c NULL, on errors
16182     *
16183     * This function inserts a new slideshow widget on the canvas.
16184     *
16185     * @ingroup Slideshow
16186     */
16187    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16188
16189    /**
16190     * Add (append) a new item in a given slideshow widget.
16191     *
16192     * @param obj The slideshow object
16193     * @param itc The item class for the item
16194     * @param data The item's data
16195     * @return A handle to the item added or @c NULL, on errors
16196     *
16197     * Add a new item to @p obj's internal list of items, appending it.
16198     * The item's class must contain the function really fetching the
16199     * image object to show for this item, which could be an Evas image
16200     * object or an Elementary photo, for example. The @p data
16201     * parameter is going to be passed to both class functions of the
16202     * item.
16203     *
16204     * @see #Elm_Slideshow_Item_Class
16205     * @see elm_slideshow_item_sorted_insert()
16206     *
16207     * @ingroup Slideshow
16208     */
16209    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16210
16211    /**
16212     * Insert a new item into the given slideshow widget, using the @p func
16213     * function to sort items (by item handles).
16214     *
16215     * @param obj The slideshow object
16216     * @param itc The item class for the item
16217     * @param data The item's data
16218     * @param func The comparing function to be used to sort slideshow
16219     * items <b>by #Elm_Slideshow_Item item handles</b>
16220     * @return Returns The slideshow item handle, on success, or
16221     * @c NULL, on errors
16222     *
16223     * Add a new item to @p obj's internal list of items, in a position
16224     * determined by the @p func comparing function. The item's class
16225     * must contain the function really fetching the image object to
16226     * show for this item, which could be an Evas image object or an
16227     * Elementary photo, for example. The @p data parameter is going to
16228     * be passed to both class functions of the item.
16229     *
16230     * @see #Elm_Slideshow_Item_Class
16231     * @see elm_slideshow_item_add()
16232     *
16233     * @ingroup Slideshow
16234     */
16235    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);
16236
16237    /**
16238     * Display a given slideshow widget's item, programmatically.
16239     *
16240     * @param obj The slideshow object
16241     * @param item The item to display on @p obj's viewport
16242     *
16243     * The change between the current item and @p item will use the
16244     * transition @p obj is set to use (@see
16245     * elm_slideshow_transition_set()).
16246     *
16247     * @ingroup Slideshow
16248     */
16249    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16250
16251    /**
16252     * Slide to the @b next item, in a given slideshow widget
16253     *
16254     * @param obj The slideshow object
16255     *
16256     * The sliding animation @p obj is set to use will be the
16257     * transition effect used, after this call is issued.
16258     *
16259     * @note If the end of the slideshow's internal list of items is
16260     * reached, it'll wrap around to the list's beginning, again.
16261     *
16262     * @ingroup Slideshow
16263     */
16264    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16265
16266    /**
16267     * Slide to the @b previous item, in a given slideshow widget
16268     *
16269     * @param obj The slideshow object
16270     *
16271     * The sliding animation @p obj is set to use will be the
16272     * transition effect used, after this call is issued.
16273     *
16274     * @note If the beginning of the slideshow's internal list of items
16275     * is reached, it'll wrap around to the list's end, again.
16276     *
16277     * @ingroup Slideshow
16278     */
16279    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16280
16281    /**
16282     * Returns the list of sliding transition/effect names available, for a
16283     * given slideshow widget.
16284     *
16285     * @param obj The slideshow object
16286     * @return The list of transitions (list of @b stringshared strings
16287     * as data)
16288     *
16289     * The transitions, which come from @p obj's theme, must be an EDC
16290     * data item named @c "transitions" on the theme file, with (prefix)
16291     * names of EDC programs actually implementing them.
16292     *
16293     * The available transitions for slideshows on the default theme are:
16294     * - @c "fade" - the current item fades out, while the new one
16295     *   fades in to the slideshow's viewport.
16296     * - @c "black_fade" - the current item fades to black, and just
16297     *   then, the new item will fade in.
16298     * - @c "horizontal" - the current item slides horizontally, until
16299     *   it gets out of the slideshow's viewport, while the new item
16300     *   comes from the left to take its place.
16301     * - @c "vertical" - the current item slides vertically, until it
16302     *   gets out of the slideshow's viewport, while the new item comes
16303     *   from the bottom to take its place.
16304     * - @c "square" - the new item starts to appear from the middle of
16305     *   the current one, but with a tiny size, growing until its
16306     *   target (full) size and covering the old one.
16307     *
16308     * @warning The stringshared strings get no new references
16309     * exclusive to the user grabbing the list, here, so if you'd like
16310     * to use them out of this call's context, you'd better @c
16311     * eina_stringshare_ref() them.
16312     *
16313     * @see elm_slideshow_transition_set()
16314     *
16315     * @ingroup Slideshow
16316     */
16317    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16318
16319    /**
16320     * Set the current slide transition/effect in use for a given
16321     * slideshow widget
16322     *
16323     * @param obj The slideshow object
16324     * @param transition The new transition's name string
16325     *
16326     * If @p transition is implemented in @p obj's theme (i.e., is
16327     * contained in the list returned by
16328     * elm_slideshow_transitions_get()), this new sliding effect will
16329     * be used on the widget.
16330     *
16331     * @see elm_slideshow_transitions_get() for more details
16332     *
16333     * @ingroup Slideshow
16334     */
16335    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16336
16337    /**
16338     * Get the current slide transition/effect in use for a given
16339     * slideshow widget
16340     *
16341     * @param obj The slideshow object
16342     * @return The current transition's name
16343     *
16344     * @see elm_slideshow_transition_set() for more details
16345     *
16346     * @ingroup Slideshow
16347     */
16348    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16349
16350    /**
16351     * Set the interval between each image transition on a given
16352     * slideshow widget, <b>and start the slideshow, itself</b>
16353     *
16354     * @param obj The slideshow object
16355     * @param timeout The new displaying timeout for images
16356     *
16357     * After this call, the slideshow widget will start cycling its
16358     * view, sequentially and automatically, with the images of the
16359     * items it has. The time between each new image displayed is going
16360     * to be @p timeout, in @b seconds. If a different timeout was set
16361     * previously and an slideshow was in progress, it will continue
16362     * with the new time between transitions, after this call.
16363     *
16364     * @note A value less than or equal to 0 on @p timeout will disable
16365     * the widget's internal timer, thus halting any slideshow which
16366     * could be happening on @p obj.
16367     *
16368     * @see elm_slideshow_timeout_get()
16369     *
16370     * @ingroup Slideshow
16371     */
16372    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16373
16374    /**
16375     * Get the interval set for image transitions on a given slideshow
16376     * widget.
16377     *
16378     * @param obj The slideshow object
16379     * @return Returns the timeout set on it
16380     *
16381     * @see elm_slideshow_timeout_set() for more details
16382     *
16383     * @ingroup Slideshow
16384     */
16385    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16386
16387    /**
16388     * Set if, after a slideshow is started, for a given slideshow
16389     * widget, its items should be displayed cyclically or not.
16390     *
16391     * @param obj The slideshow object
16392     * @param loop Use @c EINA_TRUE to make it cycle through items or
16393     * @c EINA_FALSE for it to stop at the end of @p obj's internal
16394     * list of items
16395     *
16396     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16397     * ignore what is set by this functions, i.e., they'll @b always
16398     * cycle through items. This affects only the "automatic"
16399     * slideshow, as set by elm_slideshow_timeout_set().
16400     *
16401     * @see elm_slideshow_loop_get()
16402     *
16403     * @ingroup Slideshow
16404     */
16405    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16406
16407    /**
16408     * Get if, after a slideshow is started, for a given slideshow
16409     * widget, its items are to be displayed cyclically or not.
16410     *
16411     * @param obj The slideshow object
16412     * @return @c EINA_TRUE, if the items in @p obj will be cycled
16413     * through or @c EINA_FALSE, otherwise
16414     *
16415     * @see elm_slideshow_loop_set() for more details
16416     *
16417     * @ingroup Slideshow
16418     */
16419    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16420
16421    /**
16422     * Remove all items from a given slideshow widget
16423     *
16424     * @param obj The slideshow object
16425     *
16426     * This removes (and deletes) all items in @p obj, leaving it
16427     * empty.
16428     *
16429     * @see elm_slideshow_item_del(), to remove just one item.
16430     *
16431     * @ingroup Slideshow
16432     */
16433    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16434
16435    /**
16436     * Get the internal list of items in a given slideshow widget.
16437     *
16438     * @param obj The slideshow object
16439     * @return The list of items (#Elm_Slideshow_Item as data) or
16440     * @c NULL on errors.
16441     *
16442     * This list is @b not to be modified in any way and must not be
16443     * freed. Use the list members with functions like
16444     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16445     *
16446     * @warning This list is only valid until @p obj object's internal
16447     * items list is changed. It should be fetched again with another
16448     * call to this function when changes happen.
16449     *
16450     * @ingroup Slideshow
16451     */
16452    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16453
16454    /**
16455     * Delete a given item from a slideshow widget.
16456     *
16457     * @param item The slideshow item
16458     *
16459     * @ingroup Slideshow
16460     */
16461    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16462
16463    /**
16464     * Return the data associated with a given slideshow item
16465     *
16466     * @param item The slideshow item
16467     * @return Returns the data associated to this item
16468     *
16469     * @ingroup Slideshow
16470     */
16471    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16472
16473    /**
16474     * Returns the currently displayed item, in a given slideshow widget
16475     *
16476     * @param obj The slideshow object
16477     * @return A handle to the item being displayed in @p obj or
16478     * @c NULL, if none is (and on errors)
16479     *
16480     * @ingroup Slideshow
16481     */
16482    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16483
16484    /**
16485     * Get the real Evas object created to implement the view of a
16486     * given slideshow item
16487     *
16488     * @param item The slideshow item.
16489     * @return the Evas object implementing this item's view.
16490     *
16491     * This returns the actual Evas object used to implement the
16492     * specified slideshow item's view. This may be @c NULL, as it may
16493     * not have been created or may have been deleted, at any time, by
16494     * the slideshow. <b>Do not modify this object</b> (move, resize,
16495     * show, hide, etc.), as the slideshow is controlling it. This
16496     * function is for querying, emitting custom signals or hooking
16497     * lower level callbacks for events on that object. Do not delete
16498     * this object under any circumstances.
16499     *
16500     * @see elm_slideshow_item_data_get()
16501     *
16502     * @ingroup Slideshow
16503     */
16504    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16505
16506    /**
16507     * Get the the item, in a given slideshow widget, placed at
16508     * position @p nth, in its internal items list
16509     *
16510     * @param obj The slideshow object
16511     * @param nth The number of the item to grab a handle to (0 being
16512     * the first)
16513     * @return The item stored in @p obj at position @p nth or @c NULL,
16514     * if there's no item with that index (and on errors)
16515     *
16516     * @ingroup Slideshow
16517     */
16518    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16519
16520    /**
16521     * Set the current slide layout in use for a given slideshow widget
16522     *
16523     * @param obj The slideshow object
16524     * @param layout The new layout's name string
16525     *
16526     * If @p layout is implemented in @p obj's theme (i.e., is contained
16527     * in the list returned by elm_slideshow_layouts_get()), this new
16528     * images layout will be used on the widget.
16529     *
16530     * @see elm_slideshow_layouts_get() for more details
16531     *
16532     * @ingroup Slideshow
16533     */
16534    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16535
16536    /**
16537     * Get the current slide layout in use for a given slideshow widget
16538     *
16539     * @param obj The slideshow object
16540     * @return The current layout's name
16541     *
16542     * @see elm_slideshow_layout_set() for more details
16543     *
16544     * @ingroup Slideshow
16545     */
16546    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16547
16548    /**
16549     * Returns the list of @b layout names available, for a given
16550     * slideshow widget.
16551     *
16552     * @param obj The slideshow object
16553     * @return The list of layouts (list of @b stringshared strings
16554     * as data)
16555     *
16556     * Slideshow layouts will change how the widget is to dispose each
16557     * image item in its viewport, with regard to cropping, scaling,
16558     * etc.
16559     *
16560     * The layouts, which come from @p obj's theme, must be an EDC
16561     * data item name @c "layouts" on the theme file, with (prefix)
16562     * names of EDC programs actually implementing them.
16563     *
16564     * The available layouts for slideshows on the default theme are:
16565     * - @c "fullscreen" - item images with original aspect, scaled to
16566     *   touch top and down slideshow borders or, if the image's heigh
16567     *   is not enough, left and right slideshow borders.
16568     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16569     *   one, but always leaving 10% of the slideshow's dimensions of
16570     *   distance between the item image's borders and the slideshow
16571     *   borders, for each axis.
16572     *
16573     * @warning The stringshared strings get no new references
16574     * exclusive to the user grabbing the list, here, so if you'd like
16575     * to use them out of this call's context, you'd better @c
16576     * eina_stringshare_ref() them.
16577     *
16578     * @see elm_slideshow_layout_set()
16579     *
16580     * @ingroup Slideshow
16581     */
16582    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16583
16584    /**
16585     * Set the number of items to cache, on a given slideshow widget,
16586     * <b>before the current item</b>
16587     *
16588     * @param obj The slideshow object
16589     * @param count Number of items to cache before the current one
16590     *
16591     * The default value for this property is @c 2. See
16592     * @ref Slideshow_Caching "slideshow caching" for more details.
16593     *
16594     * @see elm_slideshow_cache_before_get()
16595     *
16596     * @ingroup Slideshow
16597     */
16598    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16599
16600    /**
16601     * Retrieve the number of items to cache, on a given slideshow widget,
16602     * <b>before the current item</b>
16603     *
16604     * @param obj The slideshow object
16605     * @return The number of items set to be cached before the current one
16606     *
16607     * @see elm_slideshow_cache_before_set() for more details
16608     *
16609     * @ingroup Slideshow
16610     */
16611    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16612
16613    /**
16614     * Set the number of items to cache, on a given slideshow widget,
16615     * <b>after the current item</b>
16616     *
16617     * @param obj The slideshow object
16618     * @param count Number of items to cache after the current one
16619     *
16620     * The default value for this property is @c 2. See
16621     * @ref Slideshow_Caching "slideshow caching" for more details.
16622     *
16623     * @see elm_slideshow_cache_after_get()
16624     *
16625     * @ingroup Slideshow
16626     */
16627    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16628
16629    /**
16630     * Retrieve the number of items to cache, on a given slideshow widget,
16631     * <b>after the current item</b>
16632     *
16633     * @param obj The slideshow object
16634     * @return The number of items set to be cached after the current one
16635     *
16636     * @see elm_slideshow_cache_after_set() for more details
16637     *
16638     * @ingroup Slideshow
16639     */
16640    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16641
16642    /**
16643     * Get the number of items stored in a given slideshow widget
16644     *
16645     * @param obj The slideshow object
16646     * @return The number of items on @p obj, at the moment of this call
16647     *
16648     * @ingroup Slideshow
16649     */
16650    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16651
16652    /**
16653     * @}
16654     */
16655
16656    /**
16657     * @defgroup Fileselector File Selector
16658     *
16659     * @image html img/widget/fileselector/preview-00.png
16660     * @image latex img/widget/fileselector/preview-00.eps
16661     *
16662     * A file selector is a widget that allows a user to navigate
16663     * through a file system, reporting file selections back via its
16664     * API.
16665     *
16666     * It contains shortcut buttons for home directory (@c ~) and to
16667     * jump one directory upwards (..), as well as cancel/ok buttons to
16668     * confirm/cancel a given selection. After either one of those two
16669     * former actions, the file selector will issue its @c "done" smart
16670     * callback.
16671     *
16672     * There's a text entry on it, too, showing the name of the current
16673     * selection. There's the possibility of making it editable, so it
16674     * is useful on file saving dialogs on applications, where one
16675     * gives a file name to save contents to, in a given directory in
16676     * the system. This custom file name will be reported on the @c
16677     * "done" smart callback (explained in sequence).
16678     *
16679     * Finally, it has a view to display file system items into in two
16680     * possible forms:
16681     * - list
16682     * - grid
16683     *
16684     * If Elementary is built with support of the Ethumb thumbnailing
16685     * library, the second form of view will display preview thumbnails
16686     * of files which it supports.
16687     *
16688     * Smart callbacks one can register to:
16689     *
16690     * - @c "selected" - the user has clicked on a file (when not in
16691     *      folders-only mode) or directory (when in folders-only mode)
16692     * - @c "directory,open" - the list has been populated with new
16693     *      content (@c event_info is a pointer to the directory's
16694     *      path, a @b stringshared string)
16695     * - @c "done" - the user has clicked on the "ok" or "cancel"
16696     *      buttons (@c event_info is a pointer to the selection's
16697     *      path, a @b stringshared string)
16698     *
16699     * Here is an example on its usage:
16700     * @li @ref fileselector_example
16701     */
16702
16703    /**
16704     * @addtogroup Fileselector
16705     * @{
16706     */
16707
16708    /**
16709     * Defines how a file selector widget is to layout its contents
16710     * (file system entries).
16711     */
16712    typedef enum _Elm_Fileselector_Mode
16713      {
16714         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
16715         ELM_FILESELECTOR_GRID, /**< layout as a grid */
16716         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
16717      } Elm_Fileselector_Mode;
16718
16719    /**
16720     * Add a new file selector widget to the given parent Elementary
16721     * (container) object
16722     *
16723     * @param parent The parent object
16724     * @return a new file selector widget handle or @c NULL, on errors
16725     *
16726     * This function inserts a new file selector widget on the canvas.
16727     *
16728     * @ingroup Fileselector
16729     */
16730    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16731
16732    /**
16733     * Enable/disable the file name entry box where the user can type
16734     * in a name for a file, in a given file selector widget
16735     *
16736     * @param obj The file selector object
16737     * @param is_save @c EINA_TRUE to make the file selector a "saving
16738     * dialog", @c EINA_FALSE otherwise
16739     *
16740     * Having the entry editable is useful on file saving dialogs on
16741     * applications, where one gives a file name to save contents to,
16742     * in a given directory in the system. This custom file name will
16743     * be reported on the @c "done" smart callback.
16744     *
16745     * @see elm_fileselector_is_save_get()
16746     *
16747     * @ingroup Fileselector
16748     */
16749    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
16750
16751    /**
16752     * Get whether the given file selector is in "saving dialog" mode
16753     *
16754     * @param obj The file selector object
16755     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
16756     * mode, @c EINA_FALSE otherwise (and on errors)
16757     *
16758     * @see elm_fileselector_is_save_set() for more details
16759     *
16760     * @ingroup Fileselector
16761     */
16762    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16763
16764    /**
16765     * Enable/disable folder-only view for a given file selector widget
16766     *
16767     * @param obj The file selector object
16768     * @param only @c EINA_TRUE to make @p obj only display
16769     * directories, @c EINA_FALSE to make files to be displayed in it
16770     * too
16771     *
16772     * If enabled, the widget's view will only display folder items,
16773     * naturally.
16774     *
16775     * @see elm_fileselector_folder_only_get()
16776     *
16777     * @ingroup Fileselector
16778     */
16779    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
16780
16781    /**
16782     * Get whether folder-only view is set for a given file selector
16783     * widget
16784     *
16785     * @param obj The file selector object
16786     * @return only @c EINA_TRUE if @p obj is only displaying
16787     * directories, @c EINA_FALSE if files are being displayed in it
16788     * too (and on errors)
16789     *
16790     * @see elm_fileselector_folder_only_get()
16791     *
16792     * @ingroup Fileselector
16793     */
16794    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16795
16796    /**
16797     * Enable/disable the "ok" and "cancel" buttons on a given file
16798     * selector widget
16799     *
16800     * @param obj The file selector object
16801     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
16802     *
16803     * @note A file selector without those buttons will never emit the
16804     * @c "done" smart event, and is only usable if one is just hooking
16805     * to the other two events.
16806     *
16807     * @see elm_fileselector_buttons_ok_cancel_get()
16808     *
16809     * @ingroup Fileselector
16810     */
16811    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
16812
16813    /**
16814     * Get whether the "ok" and "cancel" buttons on a given file
16815     * selector widget are being shown.
16816     *
16817     * @param obj The file selector object
16818     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
16819     * otherwise (and on errors)
16820     *
16821     * @see elm_fileselector_buttons_ok_cancel_set() for more details
16822     *
16823     * @ingroup Fileselector
16824     */
16825    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16826
16827    /**
16828     * Enable/disable a tree view in the given file selector widget,
16829     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
16830     *
16831     * @param obj The file selector object
16832     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
16833     * disable
16834     *
16835     * In a tree view, arrows are created on the sides of directories,
16836     * allowing them to expand in place.
16837     *
16838     * @note If it's in other mode, the changes made by this function
16839     * will only be visible when one switches back to "list" mode.
16840     *
16841     * @see elm_fileselector_expandable_get()
16842     *
16843     * @ingroup Fileselector
16844     */
16845    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
16846
16847    /**
16848     * Get whether tree view is enabled for the given file selector
16849     * widget
16850     *
16851     * @param obj The file selector object
16852     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
16853     * otherwise (and or errors)
16854     *
16855     * @see elm_fileselector_expandable_set() for more details
16856     *
16857     * @ingroup Fileselector
16858     */
16859    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16860
16861    /**
16862     * Set, programmatically, the @b directory that a given file
16863     * selector widget will display contents from
16864     *
16865     * @param obj The file selector object
16866     * @param path The path to display in @p obj
16867     *
16868     * This will change the @b directory that @p obj is displaying. It
16869     * will also clear the text entry area on the @p obj object, which
16870     * displays select files' names.
16871     *
16872     * @see elm_fileselector_path_get()
16873     *
16874     * @ingroup Fileselector
16875     */
16876    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16877
16878    /**
16879     * Get the parent directory's path that a given file selector
16880     * widget is displaying
16881     *
16882     * @param obj The file selector object
16883     * @return The (full) path of the directory the file selector is
16884     * displaying, a @b stringshared string
16885     *
16886     * @see elm_fileselector_path_set()
16887     *
16888     * @ingroup Fileselector
16889     */
16890    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16891
16892    /**
16893     * Set, programmatically, the currently selected file/directory in
16894     * the given file selector widget
16895     *
16896     * @param obj The file selector object
16897     * @param path The (full) path to a file or directory
16898     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
16899     * latter case occurs if the directory or file pointed to do not
16900     * exist.
16901     *
16902     * @see elm_fileselector_selected_get()
16903     *
16904     * @ingroup Fileselector
16905     */
16906    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16907
16908    /**
16909     * Get the currently selected item's (full) path, in the given file
16910     * selector widget
16911     *
16912     * @param obj The file selector object
16913     * @return The absolute path of the selected item, a @b
16914     * stringshared string
16915     *
16916     * @note Custom editions on @p obj object's text entry, if made,
16917     * will appear on the return string of this function, naturally.
16918     *
16919     * @see elm_fileselector_selected_set() for more details
16920     *
16921     * @ingroup Fileselector
16922     */
16923    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16924
16925    /**
16926     * Set the mode in which a given file selector widget will display
16927     * (layout) file system entries in its view
16928     *
16929     * @param obj The file selector object
16930     * @param mode The mode of the fileselector, being it one of
16931     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
16932     * first one, naturally, will display the files in a list. The
16933     * latter will make the widget to display its entries in a grid
16934     * form.
16935     *
16936     * @note By using elm_fileselector_expandable_set(), the user may
16937     * trigger a tree view for that list.
16938     *
16939     * @note If Elementary is built with support of the Ethumb
16940     * thumbnailing library, the second form of view will display
16941     * preview thumbnails of files which it supports. You must have
16942     * elm_need_ethumb() called in your Elementary for thumbnailing to
16943     * work, though.
16944     *
16945     * @see elm_fileselector_expandable_set().
16946     * @see elm_fileselector_mode_get().
16947     *
16948     * @ingroup Fileselector
16949     */
16950    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
16951
16952    /**
16953     * Get the mode in which a given file selector widget is displaying
16954     * (layouting) file system entries in its view
16955     *
16956     * @param obj The fileselector object
16957     * @return The mode in which the fileselector is at
16958     *
16959     * @see elm_fileselector_mode_set() for more details
16960     *
16961     * @ingroup Fileselector
16962     */
16963    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16964
16965    /**
16966     * @}
16967     */
16968
16969    /**
16970     * @defgroup Progressbar Progress bar
16971     *
16972     * The progress bar is a widget for visually representing the
16973     * progress status of a given job/task.
16974     *
16975     * A progress bar may be horizontal or vertical. It may display an
16976     * icon besides it, as well as primary and @b units labels. The
16977     * former is meant to label the widget as a whole, while the
16978     * latter, which is formatted with floating point values (and thus
16979     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
16980     * units"</c>), is meant to label the widget's <b>progress
16981     * value</b>. Label, icon and unit strings/objects are @b optional
16982     * for progress bars.
16983     *
16984     * A progress bar may be @b inverted, in which state it gets its
16985     * values inverted, with high values being on the left or top and
16986     * low values on the right or bottom, as opposed to normally have
16987     * the low values on the former and high values on the latter,
16988     * respectively, for horizontal and vertical modes.
16989     *
16990     * The @b span of the progress, as set by
16991     * elm_progressbar_span_size_set(), is its length (horizontally or
16992     * vertically), unless one puts size hints on the widget to expand
16993     * on desired directions, by any container. That length will be
16994     * scaled by the object or applications scaling factor. At any
16995     * point code can query the progress bar for its value with
16996     * elm_progressbar_value_get().
16997     *
16998     * Available widget styles for progress bars:
16999     * - @c "default"
17000     * - @c "wheel" (simple style, no text, no progression, only
17001     *      "pulse" effect is available)
17002     *
17003     * Here is an example on its usage:
17004     * @li @ref progressbar_example
17005     */
17006
17007    /**
17008     * Add a new progress bar widget to the given parent Elementary
17009     * (container) object
17010     *
17011     * @param parent The parent object
17012     * @return a new progress bar widget handle or @c NULL, on errors
17013     *
17014     * This function inserts a new progress bar widget on the canvas.
17015     *
17016     * @ingroup Progressbar
17017     */
17018    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17019
17020    /**
17021     * Set whether a given progress bar widget is at "pulsing mode" or
17022     * not.
17023     *
17024     * @param obj The progress bar object
17025     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17026     * @c EINA_FALSE to put it back to its default one
17027     *
17028     * By default, progress bars will display values from the low to
17029     * high value boundaries. There are, though, contexts in which the
17030     * state of progression of a given task is @b unknown.  For those,
17031     * one can set a progress bar widget to a "pulsing state", to give
17032     * the user an idea that some computation is being held, but
17033     * without exact progress values. In the default theme it will
17034     * animate its bar with the contents filling in constantly and back
17035     * to non-filled, in a loop. To start and stop this pulsing
17036     * animation, one has to explicitly call elm_progressbar_pulse().
17037     *
17038     * @see elm_progressbar_pulse_get()
17039     * @see elm_progressbar_pulse()
17040     *
17041     * @ingroup Progressbar
17042     */
17043    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17044
17045    /**
17046     * Get whether a given progress bar widget is at "pulsing mode" or
17047     * not.
17048     *
17049     * @param obj The progress bar object
17050     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17051     * if it's in the default one (and on errors)
17052     *
17053     * @ingroup Progressbar
17054     */
17055    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17056
17057    /**
17058     * Start/stop a given progress bar "pulsing" animation, if its
17059     * under that mode
17060     *
17061     * @param obj The progress bar object
17062     * @param state @c EINA_TRUE, to @b start the pulsing animation,
17063     * @c EINA_FALSE to @b stop it
17064     *
17065     * @note This call won't do anything if @p obj is not under "pulsing mode".
17066     *
17067     * @see elm_progressbar_pulse_set() for more details.
17068     *
17069     * @ingroup Progressbar
17070     */
17071    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17072
17073    /**
17074     * Set the progress value (in percentage) on a given progress bar
17075     * widget
17076     *
17077     * @param obj The progress bar object
17078     * @param val The progress value (@b must be between @c 0.0 and @c
17079     * 1.0)
17080     *
17081     * Use this call to set progress bar levels.
17082     *
17083     * @note If you passes a value out of the specified range for @p
17084     * val, it will be interpreted as the @b closest of the @b boundary
17085     * values in the range.
17086     *
17087     * @ingroup Progressbar
17088     */
17089    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17090
17091    /**
17092     * Get the progress value (in percentage) on a given progress bar
17093     * widget
17094     *
17095     * @param obj The progress bar object
17096     * @return The value of the progressbar
17097     *
17098     * @see elm_progressbar_value_set() for more details
17099     *
17100     * @ingroup Progressbar
17101     */
17102    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17103
17104    /**
17105     * Set the label of a given progress bar widget
17106     *
17107     * @param obj The progress bar object
17108     * @param label The text label string, in UTF-8
17109     *
17110     * @ingroup Progressbar
17111     * @deprecated use elm_object_text_set() instead.
17112     */
17113    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17114
17115    /**
17116     * Get the label of a given progress bar widget
17117     *
17118     * @param obj The progressbar object
17119     * @return The text label string, in UTF-8
17120     *
17121     * @ingroup Progressbar
17122     * @deprecated use elm_object_text_set() instead.
17123     */
17124    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17125
17126    /**
17127     * Set the icon object of a given progress bar widget
17128     *
17129     * @param obj The progress bar object
17130     * @param icon The icon object
17131     *
17132     * Use this call to decorate @p obj with an icon next to it.
17133     *
17134     * @note Once the icon object is set, a previously set one will be
17135     * deleted. If you want to keep that old content object, use the
17136     * elm_progressbar_icon_unset() function.
17137     *
17138     * @see elm_progressbar_icon_get()
17139     *
17140     * @ingroup Progressbar
17141     */
17142    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17143
17144    /**
17145     * Retrieve the icon object set for a given progress bar widget
17146     *
17147     * @param obj The progress bar object
17148     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17149     * otherwise (and on errors)
17150     *
17151     * @see elm_progressbar_icon_set() for more details
17152     *
17153     * @ingroup Progressbar
17154     */
17155    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17156
17157    /**
17158     * Unset an icon set on a given progress bar widget
17159     *
17160     * @param obj The progress bar object
17161     * @return The icon object that was being used, if any was set, or
17162     * @c NULL, otherwise (and on errors)
17163     *
17164     * This call will unparent and return the icon object which was set
17165     * for this widget, previously, on success.
17166     *
17167     * @see elm_progressbar_icon_set() for more details
17168     *
17169     * @ingroup Progressbar
17170     */
17171    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17172
17173    /**
17174     * Set the (exact) length of the bar region of a given progress bar
17175     * widget
17176     *
17177     * @param obj The progress bar object
17178     * @param size The length of the progress bar's bar region
17179     *
17180     * This sets the minimum width (when in horizontal mode) or height
17181     * (when in vertical mode) of the actual bar area of the progress
17182     * bar @p obj. This in turn affects the object's minimum size. Use
17183     * this when you're not setting other size hints expanding on the
17184     * given direction (like weight and alignment hints) and you would
17185     * like it to have a specific size.
17186     *
17187     * @note Icon, label and unit text around @p obj will require their
17188     * own space, which will make @p obj to require more the @p size,
17189     * actually.
17190     *
17191     * @see elm_progressbar_span_size_get()
17192     *
17193     * @ingroup Progressbar
17194     */
17195    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17196
17197    /**
17198     * Get the length set for the bar region of a given progress bar
17199     * widget
17200     *
17201     * @param obj The progress bar object
17202     * @return The length of the progress bar's bar region
17203     *
17204     * If that size was not set previously, with
17205     * elm_progressbar_span_size_set(), this call will return @c 0.
17206     *
17207     * @ingroup Progressbar
17208     */
17209    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17210
17211    /**
17212     * Set the format string for a given progress bar widget's units
17213     * label
17214     *
17215     * @param obj The progress bar object
17216     * @param format The format string for @p obj's units label
17217     *
17218     * If @c NULL is passed on @p format, it will make @p obj's units
17219     * area to be hidden completely. If not, it'll set the <b>format
17220     * string</b> for the units label's @b text. The units label is
17221     * provided a floating point value, so the units text is up display
17222     * at most one floating point falue. Note that the units label is
17223     * optional. Use a format string such as "%1.2f meters" for
17224     * example.
17225     *
17226     * @note The default format string for a progress bar is an integer
17227     * percentage, as in @c "%.0f %%".
17228     *
17229     * @see elm_progressbar_unit_format_get()
17230     *
17231     * @ingroup Progressbar
17232     */
17233    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17234
17235    /**
17236     * Retrieve the format string set for a given progress bar widget's
17237     * units label
17238     *
17239     * @param obj The progress bar object
17240     * @return The format set string for @p obj's units label or
17241     * @c NULL, if none was set (and on errors)
17242     *
17243     * @see elm_progressbar_unit_format_set() for more details
17244     *
17245     * @ingroup Progressbar
17246     */
17247    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17248
17249    /**
17250     * Set the orientation of a given progress bar widget
17251     *
17252     * @param obj The progress bar object
17253     * @param horizontal Use @c EINA_TRUE to make @p obj to be
17254     * @b horizontal, @c EINA_FALSE to make it @b vertical
17255     *
17256     * Use this function to change how your progress bar is to be
17257     * disposed: vertically or horizontally.
17258     *
17259     * @see elm_progressbar_horizontal_get()
17260     *
17261     * @ingroup Progressbar
17262     */
17263    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17264
17265    /**
17266     * Retrieve the orientation of a given progress bar widget
17267     *
17268     * @param obj The progress bar object
17269     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17270     * @c EINA_FALSE if it's @b vertical (and on errors)
17271     *
17272     * @see elm_progressbar_horizontal_set() for more details
17273     *
17274     * @ingroup Progressbar
17275     */
17276    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17277
17278    /**
17279     * Invert a given progress bar widget's displaying values order
17280     *
17281     * @param obj The progress bar object
17282     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17283     * @c EINA_FALSE to bring it back to default, non-inverted values.
17284     *
17285     * A progress bar may be @b inverted, in which state it gets its
17286     * values inverted, with high values being on the left or top and
17287     * low values on the right or bottom, as opposed to normally have
17288     * the low values on the former and high values on the latter,
17289     * respectively, for horizontal and vertical modes.
17290     *
17291     * @see elm_progressbar_inverted_get()
17292     *
17293     * @ingroup Progressbar
17294     */
17295    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17296
17297    /**
17298     * Get whether a given progress bar widget's displaying values are
17299     * inverted or not
17300     *
17301     * @param obj The progress bar object
17302     * @return @c EINA_TRUE, if @p obj has inverted values,
17303     * @c EINA_FALSE otherwise (and on errors)
17304     *
17305     * @see elm_progressbar_inverted_set() for more details
17306     *
17307     * @ingroup Progressbar
17308     */
17309    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17310
17311    /**
17312     * @defgroup Separator Separator
17313     *
17314     * @brief Separator is a very thin object used to separate other objects.
17315     *
17316     * A separator can be vertical or horizontal.
17317     *
17318     * @ref tutorial_separator is a good example of how to use a separator.
17319     * @{
17320     */
17321    /**
17322     * @brief Add a separator object to @p parent
17323     *
17324     * @param parent The parent object
17325     *
17326     * @return The separator object, or NULL upon failure
17327     */
17328    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17329    /**
17330     * @brief Set the horizontal mode of a separator object
17331     *
17332     * @param obj The separator object
17333     * @param horizontal If true, the separator is horizontal
17334     */
17335    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17336    /**
17337     * @brief Get the horizontal mode of a separator object
17338     *
17339     * @param obj The separator object
17340     * @return If true, the separator is horizontal
17341     *
17342     * @see elm_separator_horizontal_set()
17343     */
17344    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17345    /**
17346     * @}
17347     */
17348
17349    /**
17350     * @defgroup Spinner Spinner
17351     * @ingroup Elementary
17352     *
17353     * @image html img/widget/spinner/preview-00.png
17354     * @image latex img/widget/spinner/preview-00.eps
17355     *
17356     * A spinner is a widget which allows the user to increase or decrease
17357     * numeric values using arrow buttons, or edit values directly, clicking
17358     * over it and typing the new value.
17359     *
17360     * By default the spinner will not wrap and has a label
17361     * of "%.0f" (just showing the integer value of the double).
17362     *
17363     * A spinner has a label that is formatted with floating
17364     * point values and thus accepts a printf-style format string, like
17365     * “%1.2f units”.
17366     *
17367     * It also allows specific values to be replaced by pre-defined labels.
17368     *
17369     * Smart callbacks one can register to:
17370     *
17371     * - "changed" - Whenever the spinner value is changed.
17372     * - "delay,changed" - A short time after the value is changed by the user.
17373     *    This will be called only when the user stops dragging for a very short
17374     *    period or when they release their finger/mouse, so it avoids possibly
17375     *    expensive reactions to the value change.
17376     *
17377     * Available styles for it:
17378     * - @c "default";
17379     * - @c "vertical": up/down buttons at the right side and text left aligned.
17380     *
17381     * Here is an example on its usage:
17382     * @ref spinner_example
17383     */
17384
17385    /**
17386     * @addtogroup Spinner
17387     * @{
17388     */
17389
17390    /**
17391     * Add a new spinner widget to the given parent Elementary
17392     * (container) object.
17393     *
17394     * @param parent The parent object.
17395     * @return a new spinner widget handle or @c NULL, on errors.
17396     *
17397     * This function inserts a new spinner widget on the canvas.
17398     *
17399     * @ingroup Spinner
17400     *
17401     */
17402    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17403
17404    /**
17405     * Set the format string of the displayed label.
17406     *
17407     * @param obj The spinner object.
17408     * @param fmt The format string for the label display.
17409     *
17410     * If @c NULL, this sets the format to "%.0f". If not it sets the format
17411     * string for the label text. The label text is provided a floating point
17412     * value, so the label text can display up to 1 floating point value.
17413     * Note that this is optional.
17414     *
17415     * Use a format string such as "%1.2f meters" for example, and it will
17416     * display values like: "3.14 meters" for a value equal to 3.14159.
17417     *
17418     * Default is "%0.f".
17419     *
17420     * @see elm_spinner_label_format_get()
17421     *
17422     * @ingroup Spinner
17423     */
17424    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17425
17426    /**
17427     * Get the label format of the spinner.
17428     *
17429     * @param obj The spinner object.
17430     * @return The text label format string in UTF-8.
17431     *
17432     * @see elm_spinner_label_format_set() for details.
17433     *
17434     * @ingroup Spinner
17435     */
17436    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17437
17438    /**
17439     * Set the minimum and maximum values for the spinner.
17440     *
17441     * @param obj The spinner object.
17442     * @param min The minimum value.
17443     * @param max The maximum value.
17444     *
17445     * Define the allowed range of values to be selected by the user.
17446     *
17447     * If actual value is less than @p min, it will be updated to @p min. If it
17448     * is bigger then @p max, will be updated to @p max. Actual value can be
17449     * get with elm_spinner_value_get().
17450     *
17451     * By default, min is equal to 0, and max is equal to 100.
17452     *
17453     * @warning Maximum must be greater than minimum.
17454     *
17455     * @see elm_spinner_min_max_get()
17456     *
17457     * @ingroup Spinner
17458     */
17459    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17460
17461    /**
17462     * Get the minimum and maximum values of the spinner.
17463     *
17464     * @param obj The spinner object.
17465     * @param min Pointer where to store the minimum value.
17466     * @param max Pointer where to store the maximum value.
17467     *
17468     * @note If only one value is needed, the other pointer can be passed
17469     * as @c NULL.
17470     *
17471     * @see elm_spinner_min_max_set() for details.
17472     *
17473     * @ingroup Spinner
17474     */
17475    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17476
17477    /**
17478     * Set the step used to increment or decrement the spinner value.
17479     *
17480     * @param obj The spinner object.
17481     * @param step The step value.
17482     *
17483     * This value will be incremented or decremented to the displayed value.
17484     * It will be incremented while the user keep right or top arrow pressed,
17485     * and will be decremented while the user keep left or bottom arrow pressed.
17486     *
17487     * The interval to increment / decrement can be set with
17488     * elm_spinner_interval_set().
17489     *
17490     * By default step value is equal to 1.
17491     *
17492     * @see elm_spinner_step_get()
17493     *
17494     * @ingroup Spinner
17495     */
17496    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17497
17498    /**
17499     * Get the step used to increment or decrement the spinner value.
17500     *
17501     * @param obj The spinner object.
17502     * @return The step value.
17503     *
17504     * @see elm_spinner_step_get() for more details.
17505     *
17506     * @ingroup Spinner
17507     */
17508    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17509
17510    /**
17511     * Set the value the spinner displays.
17512     *
17513     * @param obj The spinner object.
17514     * @param val The value to be displayed.
17515     *
17516     * Value will be presented on the label following format specified with
17517     * elm_spinner_format_set().
17518     *
17519     * @warning The value must to be between min and max values. This values
17520     * are set by elm_spinner_min_max_set().
17521     *
17522     * @see elm_spinner_value_get().
17523     * @see elm_spinner_format_set().
17524     * @see elm_spinner_min_max_set().
17525     *
17526     * @ingroup Spinner
17527     */
17528    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17529
17530    /**
17531     * Get the value displayed by the spinner.
17532     *
17533     * @param obj The spinner object.
17534     * @return The value displayed.
17535     *
17536     * @see elm_spinner_value_set() for details.
17537     *
17538     * @ingroup Spinner
17539     */
17540    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17541
17542    /**
17543     * Set whether the spinner should wrap when it reaches its
17544     * minimum or maximum value.
17545     *
17546     * @param obj The spinner object.
17547     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17548     * disable it.
17549     *
17550     * Disabled by default. If disabled, when the user tries to increment the
17551     * value,
17552     * but displayed value plus step value is bigger than maximum value,
17553     * the spinner
17554     * won't allow it. The same happens when the user tries to decrement it,
17555     * but the value less step is less than minimum value.
17556     *
17557     * When wrap is enabled, in such situations it will allow these changes,
17558     * but will get the value that would be less than minimum and subtracts
17559     * from maximum. Or add the value that would be more than maximum to
17560     * the minimum.
17561     *
17562     * E.g.:
17563     * @li min value = 10
17564     * @li max value = 50
17565     * @li step value = 20
17566     * @li displayed value = 20
17567     *
17568     * When the user decrement value (using left or bottom arrow), it will
17569     * displays @c 40, because max - (min - (displayed - step)) is
17570     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17571     *
17572     * @see elm_spinner_wrap_get().
17573     *
17574     * @ingroup Spinner
17575     */
17576    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17577
17578    /**
17579     * Get whether the spinner should wrap when it reaches its
17580     * minimum or maximum value.
17581     *
17582     * @param obj The spinner object
17583     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17584     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17585     *
17586     * @see elm_spinner_wrap_set() for details.
17587     *
17588     * @ingroup Spinner
17589     */
17590    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17591
17592    /**
17593     * Set whether the spinner can be directly edited by the user or not.
17594     *
17595     * @param obj The spinner object.
17596     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17597     * don't allow users to edit it directly.
17598     *
17599     * Spinner objects can have edition @b disabled, in which state they will
17600     * be changed only by arrows.
17601     * Useful for contexts
17602     * where you don't want your users to interact with it writting the value.
17603     * Specially
17604     * when using special values, the user can see real value instead
17605     * of special label on edition.
17606     *
17607     * It's enabled by default.
17608     *
17609     * @see elm_spinner_editable_get()
17610     *
17611     * @ingroup Spinner
17612     */
17613    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17614
17615    /**
17616     * Get whether the spinner can be directly edited by the user or not.
17617     *
17618     * @param obj The spinner object.
17619     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17620     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17621     *
17622     * @see elm_spinner_editable_set() for details.
17623     *
17624     * @ingroup Spinner
17625     */
17626    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17627
17628    /**
17629     * Set a special string to display in the place of the numerical value.
17630     *
17631     * @param obj The spinner object.
17632     * @param value The value to be replaced.
17633     * @param label The label to be used.
17634     *
17635     * It's useful for cases when a user should select an item that is
17636     * better indicated by a label than a value. For example, weekdays or months.
17637     *
17638     * E.g.:
17639     * @code
17640     * sp = elm_spinner_add(win);
17641     * elm_spinner_min_max_set(sp, 1, 3);
17642     * elm_spinner_special_value_add(sp, 1, "January");
17643     * elm_spinner_special_value_add(sp, 2, "February");
17644     * elm_spinner_special_value_add(sp, 3, "March");
17645     * evas_object_show(sp);
17646     * @endcode
17647     *
17648     * @ingroup Spinner
17649     */
17650    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17651
17652    /**
17653     * Set the interval on time updates for an user mouse button hold
17654     * on spinner widgets' arrows.
17655     *
17656     * @param obj The spinner object.
17657     * @param interval The (first) interval value in seconds.
17658     *
17659     * This interval value is @b decreased while the user holds the
17660     * mouse pointer either incrementing or decrementing spinner's value.
17661     *
17662     * This helps the user to get to a given value distant from the
17663     * current one easier/faster, as it will start to change quicker and
17664     * quicker on mouse button holds.
17665     *
17666     * The calculation for the next change interval value, starting from
17667     * the one set with this call, is the previous interval divided by
17668     * @c 1.05, so it decreases a little bit.
17669     *
17670     * The default starting interval value for automatic changes is
17671     * @c 0.85 seconds.
17672     *
17673     * @see elm_spinner_interval_get()
17674     *
17675     * @ingroup Spinner
17676     */
17677    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17678
17679    /**
17680     * Get the interval on time updates for an user mouse button hold
17681     * on spinner widgets' arrows.
17682     *
17683     * @param obj The spinner object.
17684     * @return The (first) interval value, in seconds, set on it.
17685     *
17686     * @see elm_spinner_interval_set() for more details.
17687     *
17688     * @ingroup Spinner
17689     */
17690    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17691
17692    /**
17693     * @}
17694     */
17695
17696    /**
17697     * @defgroup Index Index
17698     *
17699     * @image html img/widget/index/preview-00.png
17700     *
17701     * An index widget gives you an index for fast access to whichever
17702     * group of other UI items one might have. It's a list of text
17703     * items (usually letters, for alphabetically ordered access).
17704     *
17705     * Index widgets are by default hidden and just appear when the
17706     * user clicks over it's reserved area in the canvas. In its
17707     * default theme, it's an area one @ref Fingers "finger" wide on
17708     * the right side of the index widget's container.
17709     *
17710     * When items on the index are selected, smart callbacks get
17711     * called, so that its user can make other container objects to
17712     * show a given area or child object depending on the index item
17713     * selected. You'd probably be using an index together with @ref
17714     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
17715     * "general grids".
17716     *
17717     * Smart events one  can add callbacks for are:
17718     * - @c "changed" - When the selected index item changes. @c
17719     *      event_info is the selected item's data pointer.
17720     * - @c "delay,changed" - When the selected index item changes, but
17721     *      after a small idling period. @c event_info is the selected
17722     *      item's data pointer.
17723     * - @c "selected" - When the user releases a mouse button and
17724     *      selects an item. @c event_info is the selected item's data
17725     *      pointer.
17726     * - @c "level,up" - when the user moves a finger from the first
17727     *      level to the second level
17728     * - @c "level,down" - when the user moves a finger from the second
17729     *      level to the first level
17730     *
17731     * The @c "delay,changed" event is so that it'll wait a small time
17732     * before actually reporting those events and, moreover, just the
17733     * last event happening on those time frames will actually be
17734     * reported.
17735     *
17736     * Here are some examples on its usage:
17737     * @li @ref index_example_01
17738     * @li @ref index_example_02
17739     */
17740
17741    /**
17742     * @addtogroup Index
17743     * @{
17744     */
17745
17746    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
17747
17748    /**
17749     * Add a new index widget to the given parent Elementary
17750     * (container) object
17751     *
17752     * @param parent The parent object
17753     * @return a new index widget handle or @c NULL, on errors
17754     *
17755     * This function inserts a new index widget on the canvas.
17756     *
17757     * @ingroup Index
17758     */
17759    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17760
17761    /**
17762     * Set whether a given index widget is or not visible,
17763     * programatically.
17764     *
17765     * @param obj The index object
17766     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
17767     *
17768     * Not to be confused with visible as in @c evas_object_show() --
17769     * visible with regard to the widget's auto hiding feature.
17770     *
17771     * @see elm_index_active_get()
17772     *
17773     * @ingroup Index
17774     */
17775    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
17776
17777    /**
17778     * Get whether a given index widget is currently visible or not.
17779     *
17780     * @param obj The index object
17781     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
17782     *
17783     * @see elm_index_active_set() for more details
17784     *
17785     * @ingroup Index
17786     */
17787    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17788
17789    /**
17790     * Set the items level for a given index widget.
17791     *
17792     * @param obj The index object.
17793     * @param level @c 0 or @c 1, the currently implemented levels.
17794     *
17795     * @see elm_index_item_level_get()
17796     *
17797     * @ingroup Index
17798     */
17799    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17800
17801    /**
17802     * Get the items level set for a given index widget.
17803     *
17804     * @param obj The index object.
17805     * @return @c 0 or @c 1, which are the levels @p obj might be at.
17806     *
17807     * @see elm_index_item_level_set() for more information
17808     *
17809     * @ingroup Index
17810     */
17811    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17812
17813    /**
17814     * Returns the last selected item's data, for a given index widget.
17815     *
17816     * @param obj The index object.
17817     * @return The item @b data associated to the last selected item on
17818     * @p obj (or @c NULL, on errors).
17819     *
17820     * @warning The returned value is @b not an #Elm_Index_Item item
17821     * handle, but the data associated to it (see the @c item parameter
17822     * in elm_index_item_append(), as an example).
17823     *
17824     * @ingroup Index
17825     */
17826    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17827
17828    /**
17829     * Append a new item on a given index widget.
17830     *
17831     * @param obj The index object.
17832     * @param letter Letter under which the item should be indexed
17833     * @param item The item data to set for the index's item
17834     *
17835     * Despite the most common usage of the @p letter argument is for
17836     * single char strings, one could use arbitrary strings as index
17837     * entries.
17838     *
17839     * @c item will be the pointer returned back on @c "changed", @c
17840     * "delay,changed" and @c "selected" smart events.
17841     *
17842     * @ingroup Index
17843     */
17844    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17845
17846    /**
17847     * Prepend a new item on a given index widget.
17848     *
17849     * @param obj The index object.
17850     * @param letter Letter under which the item should be indexed
17851     * @param item The item data to set for the index's item
17852     *
17853     * Despite the most common usage of the @p letter argument is for
17854     * single char strings, one could use arbitrary strings as index
17855     * entries.
17856     *
17857     * @c item will be the pointer returned back on @c "changed", @c
17858     * "delay,changed" and @c "selected" smart events.
17859     *
17860     * @ingroup Index
17861     */
17862    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17863
17864    /**
17865     * Append a new item, on a given index widget, <b>after the item
17866     * having @p relative as data</b>.
17867     *
17868     * @param obj The index object.
17869     * @param letter Letter under which the item should be indexed
17870     * @param item The item data to set for the index's item
17871     * @param relative The item data of the index item to be the
17872     * predecessor of this new one
17873     *
17874     * Despite the most common usage of the @p letter argument is for
17875     * single char strings, one could use arbitrary strings as index
17876     * entries.
17877     *
17878     * @c item will be the pointer returned back on @c "changed", @c
17879     * "delay,changed" and @c "selected" smart events.
17880     *
17881     * @note If @p relative is @c NULL or if it's not found to be data
17882     * set on any previous item on @p obj, this function will behave as
17883     * elm_index_item_append().
17884     *
17885     * @ingroup Index
17886     */
17887    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17888
17889    /**
17890     * Prepend a new item, on a given index widget, <b>after the item
17891     * having @p relative as data</b>.
17892     *
17893     * @param obj The index object.
17894     * @param letter Letter under which the item should be indexed
17895     * @param item The item data to set for the index's item
17896     * @param relative The item data of the index item to be the
17897     * successor of this new one
17898     *
17899     * Despite the most common usage of the @p letter argument is for
17900     * single char strings, one could use arbitrary strings as index
17901     * entries.
17902     *
17903     * @c item will be the pointer returned back on @c "changed", @c
17904     * "delay,changed" and @c "selected" smart events.
17905     *
17906     * @note If @p relative is @c NULL or if it's not found to be data
17907     * set on any previous item on @p obj, this function will behave as
17908     * elm_index_item_prepend().
17909     *
17910     * @ingroup Index
17911     */
17912    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17913
17914    /**
17915     * Insert a new item into the given index widget, using @p cmp_func
17916     * function to sort items (by item handles).
17917     *
17918     * @param obj The index object.
17919     * @param letter Letter under which the item should be indexed
17920     * @param item The item data to set for the index's item
17921     * @param cmp_func The comparing function to be used to sort index
17922     * items <b>by #Elm_Index_Item item handles</b>
17923     * @param cmp_data_func A @b fallback function to be called for the
17924     * sorting of index items <b>by item data</b>). It will be used
17925     * when @p cmp_func returns @c 0 (equality), which means an index
17926     * item with provided item data already exists. To decide which
17927     * data item should be pointed to by the index item in question, @p
17928     * cmp_data_func will be used. If @p cmp_data_func returns a
17929     * non-negative value, the previous index item data will be
17930     * replaced by the given @p item pointer. If the previous data need
17931     * to be freed, it should be done by the @p cmp_data_func function,
17932     * because all references to it will be lost. If this function is
17933     * not provided (@c NULL is given), index items will be @b
17934     * duplicated, if @p cmp_func returns @c 0.
17935     *
17936     * Despite the most common usage of the @p letter argument is for
17937     * single char strings, one could use arbitrary strings as index
17938     * entries.
17939     *
17940     * @c item will be the pointer returned back on @c "changed", @c
17941     * "delay,changed" and @c "selected" smart events.
17942     *
17943     * @ingroup Index
17944     */
17945    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);
17946
17947    /**
17948     * Remove an item from a given index widget, <b>to be referenced by
17949     * it's data value</b>.
17950     *
17951     * @param obj The index object
17952     * @param item The item's data pointer for the item to be removed
17953     * from @p obj
17954     *
17955     * If a deletion callback is set, via elm_index_item_del_cb_set(),
17956     * that callback function will be called by this one.
17957     *
17958     * @warning The item to be removed from @p obj will be found via
17959     * its item data pointer, and not by an #Elm_Index_Item handle.
17960     *
17961     * @ingroup Index
17962     */
17963    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
17964
17965    /**
17966     * Find a given index widget's item, <b>using item data</b>.
17967     *
17968     * @param obj The index object
17969     * @param item The item data pointed to by the desired index item
17970     * @return The index item handle, if found, or @c NULL otherwise
17971     *
17972     * @ingroup Index
17973     */
17974    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
17975
17976    /**
17977     * Removes @b all items from a given index widget.
17978     *
17979     * @param obj The index object.
17980     *
17981     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
17982     * that callback function will be called for each item in @p obj.
17983     *
17984     * @ingroup Index
17985     */
17986    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17987
17988    /**
17989     * Go to a given items level on a index widget
17990     *
17991     * @param obj The index object
17992     * @param level The index level (one of @c 0 or @c 1)
17993     *
17994     * @ingroup Index
17995     */
17996    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17997
17998    /**
17999     * Return the data associated with a given index widget item
18000     *
18001     * @param it The index widget item handle
18002     * @return The data associated with @p it
18003     *
18004     * @see elm_index_item_data_set()
18005     *
18006     * @ingroup Index
18007     */
18008    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18009
18010    /**
18011     * Set the data associated with a given index widget item
18012     *
18013     * @param it The index widget item handle
18014     * @param data The new data pointer to set to @p it
18015     *
18016     * This sets new item data on @p it.
18017     *
18018     * @warning The old data pointer won't be touched by this function, so
18019     * the user had better to free that old data himself/herself.
18020     *
18021     * @ingroup Index
18022     */
18023    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18024
18025    /**
18026     * Set the function to be called when a given index widget item is freed.
18027     *
18028     * @param it The item to set the callback on
18029     * @param func The function to call on the item's deletion
18030     *
18031     * When called, @p func will have both @c data and @c event_info
18032     * arguments with the @p it item's data value and, naturally, the
18033     * @c obj argument with a handle to the parent index widget.
18034     *
18035     * @ingroup Index
18036     */
18037    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18038
18039    /**
18040     * Get the letter (string) set on a given index widget item.
18041     *
18042     * @param it The index item handle
18043     * @return The letter string set on @p it
18044     *
18045     * @ingroup Index
18046     */
18047    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18048
18049    /**
18050     * @}
18051     */
18052
18053    /**
18054     * @defgroup Photocam Photocam
18055     *
18056     * @image html img/widget/photocam/preview-00.png
18057     * @image latex img/widget/photocam/preview-00.eps
18058     *
18059     * This is a widget specifically for displaying high-resolution digital
18060     * camera photos giving speedy feedback (fast load), low memory footprint
18061     * and zooming and panning as well as fitting logic. It is entirely focused
18062     * on jpeg images, and takes advantage of properties of the jpeg format (via
18063     * evas loader features in the jpeg loader).
18064     *
18065     * Signals that you can add callbacks for are:
18066     * @li "clicked" - This is called when a user has clicked the photo without
18067     *                 dragging around.
18068     * @li "press" - This is called when a user has pressed down on the photo.
18069     * @li "longpressed" - This is called when a user has pressed down on the
18070     *                     photo for a long time without dragging around.
18071     * @li "clicked,double" - This is called when a user has double-clicked the
18072     *                        photo.
18073     * @li "load" - Photo load begins.
18074     * @li "loaded" - This is called when the image file load is complete for the
18075     *                first view (low resolution blurry version).
18076     * @li "load,detail" - Photo detailed data load begins.
18077     * @li "loaded,detail" - This is called when the image file load is complete
18078     *                      for the detailed image data (full resolution needed).
18079     * @li "zoom,start" - Zoom animation started.
18080     * @li "zoom,stop" - Zoom animation stopped.
18081     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18082     * @li "scroll" - the content has been scrolled (moved)
18083     * @li "scroll,anim,start" - scrolling animation has started
18084     * @li "scroll,anim,stop" - scrolling animation has stopped
18085     * @li "scroll,drag,start" - dragging the contents around has started
18086     * @li "scroll,drag,stop" - dragging the contents around has stopped
18087     *
18088     * @ref tutorial_photocam shows the API in action.
18089     * @{
18090     */
18091    /**
18092     * @brief Types of zoom available.
18093     */
18094    typedef enum _Elm_Photocam_Zoom_Mode
18095      {
18096         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18097         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18098         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18099         ELM_PHOTOCAM_ZOOM_MODE_LAST
18100      } Elm_Photocam_Zoom_Mode;
18101    /**
18102     * @brief Add a new Photocam object
18103     *
18104     * @param parent The parent object
18105     * @return The new object or NULL if it cannot be created
18106     */
18107    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18108    /**
18109     * @brief Set the photo file to be shown
18110     *
18111     * @param obj The photocam object
18112     * @param file The photo file
18113     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18114     *
18115     * This sets (and shows) the specified file (with a relative or absolute
18116     * path) and will return a load error (same error that
18117     * evas_object_image_load_error_get() will return). The image will change and
18118     * adjust its size at this point and begin a background load process for this
18119     * photo that at some time in the future will be displayed at the full
18120     * quality needed.
18121     */
18122    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18123    /**
18124     * @brief Returns the path of the current image file
18125     *
18126     * @param obj The photocam object
18127     * @return Returns the path
18128     *
18129     * @see elm_photocam_file_set()
18130     */
18131    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18132    /**
18133     * @brief Set the zoom level of the photo
18134     *
18135     * @param obj The photocam object
18136     * @param zoom The zoom level to set
18137     *
18138     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18139     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18140     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18141     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18142     * 16, 32, etc.).
18143     */
18144    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18145    /**
18146     * @brief Get the zoom level of the photo
18147     *
18148     * @param obj The photocam object
18149     * @return The current zoom level
18150     *
18151     * This returns the current zoom level of the photocam object. Note that if
18152     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18153     * (which is the default), the zoom level may be changed at any time by the
18154     * photocam object itself to account for photo size and photocam viewpoer
18155     * size.
18156     *
18157     * @see elm_photocam_zoom_set()
18158     * @see elm_photocam_zoom_mode_set()
18159     */
18160    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18161    /**
18162     * @brief Set the zoom mode
18163     *
18164     * @param obj The photocam object
18165     * @param mode The desired mode
18166     *
18167     * This sets the zoom mode to manual or one of several automatic levels.
18168     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18169     * elm_photocam_zoom_set() and will stay at that level until changed by code
18170     * or until zoom mode is changed. This is the default mode. The Automatic
18171     * modes will allow the photocam object to automatically adjust zoom mode
18172     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18173     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18174     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18175     * pixels within the frame are left unfilled.
18176     */
18177    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18178    /**
18179     * @brief Get the zoom mode
18180     *
18181     * @param obj The photocam object
18182     * @return The current zoom mode
18183     *
18184     * This gets the current zoom mode of the photocam object.
18185     *
18186     * @see elm_photocam_zoom_mode_set()
18187     */
18188    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18189    /**
18190     * @brief Get the current image pixel width and height
18191     *
18192     * @param obj The photocam object
18193     * @param w A pointer to the width return
18194     * @param h A pointer to the height return
18195     *
18196     * This gets the current photo pixel width and height (for the original).
18197     * The size will be returned in the integers @p w and @p h that are pointed
18198     * to.
18199     */
18200    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18201    /**
18202     * @brief Get the area of the image that is currently shown
18203     *
18204     * @param obj
18205     * @param x A pointer to the X-coordinate of region
18206     * @param y A pointer to the Y-coordinate of region
18207     * @param w A pointer to the width
18208     * @param h A pointer to the height
18209     *
18210     * @see elm_photocam_image_region_show()
18211     * @see elm_photocam_image_region_bring_in()
18212     */
18213    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18214    /**
18215     * @brief Set the viewed portion of the image
18216     *
18217     * @param obj The photocam object
18218     * @param x X-coordinate of region in image original pixels
18219     * @param y Y-coordinate of region in image original pixels
18220     * @param w Width of region in image original pixels
18221     * @param h Height of region in image original pixels
18222     *
18223     * This shows the region of the image without using animation.
18224     */
18225    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18226    /**
18227     * @brief Bring in the viewed portion of the image
18228     *
18229     * @param obj The photocam object
18230     * @param x X-coordinate of region in image original pixels
18231     * @param y Y-coordinate of region in image original pixels
18232     * @param w Width of region in image original pixels
18233     * @param h Height of region in image original pixels
18234     *
18235     * This shows the region of the image using animation.
18236     */
18237    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18238    /**
18239     * @brief Set the paused state for photocam
18240     *
18241     * @param obj The photocam object
18242     * @param paused The pause state to set
18243     *
18244     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18245     * photocam. The default is off. This will stop zooming using animation on
18246     * zoom levels changes and change instantly. This will stop any existing
18247     * animations that are running.
18248     */
18249    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18250    /**
18251     * @brief Get the paused state for photocam
18252     *
18253     * @param obj The photocam object
18254     * @return The current paused state
18255     *
18256     * This gets the current paused state for the photocam object.
18257     *
18258     * @see elm_photocam_paused_set()
18259     */
18260    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18261    /**
18262     * @brief Get the internal low-res image used for photocam
18263     *
18264     * @param obj The photocam object
18265     * @return The internal image object handle, or NULL if none exists
18266     *
18267     * This gets the internal image object inside photocam. Do not modify it. It
18268     * is for inspection only, and hooking callbacks to. Nothing else. It may be
18269     * deleted at any time as well.
18270     */
18271    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18272    /**
18273     * @brief Set the photocam scrolling bouncing.
18274     *
18275     * @param obj The photocam object
18276     * @param h_bounce bouncing for horizontal
18277     * @param v_bounce bouncing for vertical
18278     */
18279    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18280    /**
18281     * @brief Get the photocam scrolling bouncing.
18282     *
18283     * @param obj The photocam object
18284     * @param h_bounce bouncing for horizontal
18285     * @param v_bounce bouncing for vertical
18286     *
18287     * @see elm_photocam_bounce_set()
18288     */
18289    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18290    /**
18291     * @}
18292     */
18293
18294    /**
18295     * @defgroup Map Map
18296     * @ingroup Elementary
18297     *
18298     * @image html img/widget/map/preview-00.png
18299     * @image latex img/widget/map/preview-00.eps
18300     *
18301     * This is a widget specifically for displaying a map. It uses basically
18302     * OpenStreetMap provider http://www.openstreetmap.org/,
18303     * but custom providers can be added.
18304     *
18305     * It supports some basic but yet nice features:
18306     * @li zoom and scroll
18307     * @li markers with content to be displayed when user clicks over it
18308     * @li group of markers
18309     * @li routes
18310     *
18311     * Smart callbacks one can listen to:
18312     *
18313     * - "clicked" - This is called when a user has clicked the map without
18314     *   dragging around.
18315     * - "press" - This is called when a user has pressed down on the map.
18316     * - "longpressed" - This is called when a user has pressed down on the map
18317     *   for a long time without dragging around.
18318     * - "clicked,double" - This is called when a user has double-clicked
18319     *   the map.
18320     * - "load,detail" - Map detailed data load begins.
18321     * - "loaded,detail" - This is called when all currently visible parts of
18322     *   the map are loaded.
18323     * - "zoom,start" - Zoom animation started.
18324     * - "zoom,stop" - Zoom animation stopped.
18325     * - "zoom,change" - Zoom changed when using an auto zoom mode.
18326     * - "scroll" - the content has been scrolled (moved).
18327     * - "scroll,anim,start" - scrolling animation has started.
18328     * - "scroll,anim,stop" - scrolling animation has stopped.
18329     * - "scroll,drag,start" - dragging the contents around has started.
18330     * - "scroll,drag,stop" - dragging the contents around has stopped.
18331     * - "downloaded" - This is called when all currently required map images
18332     *   are downloaded.
18333     * - "route,load" - This is called when route request begins.
18334     * - "route,loaded" - This is called when route request ends.
18335     * - "name,load" - This is called when name request begins.
18336     * - "name,loaded- This is called when name request ends.
18337     *
18338     * Available style for map widget:
18339     * - @c "default"
18340     *
18341     * Available style for markers:
18342     * - @c "radio"
18343     * - @c "radio2"
18344     * - @c "empty"
18345     *
18346     * Available style for marker bubble:
18347     * - @c "default"
18348     *
18349     * List of examples:
18350     * @li @ref map_example_01
18351     * @li @ref map_example_02
18352     * @li @ref map_example_03
18353     */
18354
18355    /**
18356     * @addtogroup Map
18357     * @{
18358     */
18359
18360    /**
18361     * @enum _Elm_Map_Zoom_Mode
18362     * @typedef Elm_Map_Zoom_Mode
18363     *
18364     * Set map's zoom behavior. It can be set to manual or automatic.
18365     *
18366     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18367     *
18368     * Values <b> don't </b> work as bitmask, only one can be choosen.
18369     *
18370     * @note Valid sizes are 2^zoom, consequently the map may be smaller
18371     * than the scroller view.
18372     *
18373     * @see elm_map_zoom_mode_set()
18374     * @see elm_map_zoom_mode_get()
18375     *
18376     * @ingroup Map
18377     */
18378    typedef enum _Elm_Map_Zoom_Mode
18379      {
18380         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18381         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18382         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18383         ELM_MAP_ZOOM_MODE_LAST
18384      } Elm_Map_Zoom_Mode;
18385
18386    /**
18387     * @enum _Elm_Map_Route_Sources
18388     * @typedef Elm_Map_Route_Sources
18389     *
18390     * Set route service to be used. By default used source is
18391     * #ELM_MAP_ROUTE_SOURCE_YOURS.
18392     *
18393     * @see elm_map_route_source_set()
18394     * @see elm_map_route_source_get()
18395     *
18396     * @ingroup Map
18397     */
18398    typedef enum _Elm_Map_Route_Sources
18399      {
18400         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18401         ELM_MAP_ROUTE_SOURCE_MONAV, /**< MoNav offers exact routing without heuristic assumptions. Its routing core is based on Contraction Hierarchies. It's not working with Map yet. */
18402         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18403         ELM_MAP_ROUTE_SOURCE_LAST
18404      } Elm_Map_Route_Sources;
18405
18406    typedef enum _Elm_Map_Name_Sources
18407      {
18408         ELM_MAP_NAME_SOURCE_NOMINATIM,
18409         ELM_MAP_NAME_SOURCE_LAST
18410      } Elm_Map_Name_Sources;
18411
18412    /**
18413     * @enum _Elm_Map_Route_Type
18414     * @typedef Elm_Map_Route_Type
18415     *
18416     * Set type of transport used on route.
18417     *
18418     * @see elm_map_route_add()
18419     *
18420     * @ingroup Map
18421     */
18422    typedef enum _Elm_Map_Route_Type
18423      {
18424         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18425         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18426         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18427         ELM_MAP_ROUTE_TYPE_LAST
18428      } Elm_Map_Route_Type;
18429
18430    /**
18431     * @enum _Elm_Map_Route_Method
18432     * @typedef Elm_Map_Route_Method
18433     *
18434     * Set the routing method, what should be priorized, time or distance.
18435     *
18436     * @see elm_map_route_add()
18437     *
18438     * @ingroup Map
18439     */
18440    typedef enum _Elm_Map_Route_Method
18441      {
18442         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18443         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18444         ELM_MAP_ROUTE_METHOD_LAST
18445      } Elm_Map_Route_Method;
18446
18447    typedef enum _Elm_Map_Name_Method
18448      {
18449         ELM_MAP_NAME_METHOD_SEARCH,
18450         ELM_MAP_NAME_METHOD_REVERSE,
18451         ELM_MAP_NAME_METHOD_LAST
18452      } Elm_Map_Name_Method;
18453
18454    typedef struct _Elm_Map_Marker          Elm_Map_Marker; /**< A marker to be shown in a specific point of the map. Can be created with elm_map_marker_add() and deleted with elm_map_marker_remove(). */
18455    typedef struct _Elm_Map_Marker_Class    Elm_Map_Marker_Class; /**< Each marker must be associated to a class. It's required to add a mark. The class defines the style of the marker when a marker is displayed alone (not grouped). A new class can be created with elm_map_marker_class_new(). */
18456    typedef struct _Elm_Map_Group_Class     Elm_Map_Group_Class; /**< Each marker must be associated to a group class. It's required to add a mark. The group class defines the style of the marker when a marker is grouped to other markers. Markers with the same group are grouped if they are close. A new group class can be created with elm_map_marker_group_class_new(). */
18457    typedef struct _Elm_Map_Route           Elm_Map_Route; /**< A route to be shown in the map. Can be created with elm_map_route_add() and deleted with elm_map_route_remove(). */
18458    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
18459    typedef struct _Elm_Map_Track           Elm_Map_Track;
18460
18461    typedef Evas_Object *(*ElmMapMarkerGetFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Bubble content fetching class function for marker classes. When the user click on a marker, a bubble is displayed with a content. */
18462    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18463    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18464    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18465
18466    typedef char        *(*ElmMapModuleSourceFunc) (void);
18467    typedef int          (*ElmMapModuleZoomMinFunc) (void);
18468    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
18469    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18470    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
18471    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18472    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18473    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18474    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18475
18476    /**
18477     * Add a new map widget to the given parent Elementary (container) object.
18478     *
18479     * @param parent The parent object.
18480     * @return a new map widget handle or @c NULL, on errors.
18481     *
18482     * This function inserts a new map widget on the canvas.
18483     *
18484     * @ingroup Map
18485     */
18486    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18487
18488    /**
18489     * Set the zoom level of the map.
18490     *
18491     * @param obj The map object.
18492     * @param zoom The zoom level to set.
18493     *
18494     * This sets the zoom level.
18495     *
18496     * It will respect limits defined by elm_map_source_zoom_min_set() and
18497     * elm_map_source_zoom_max_set().
18498     *
18499     * By default these values are 0 (world map) and 18 (maximum zoom).
18500     *
18501     * This function should be used when zoom mode is set to
18502     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18503     * with elm_map_zoom_mode_set().
18504     *
18505     * @see elm_map_zoom_mode_set().
18506     * @see elm_map_zoom_get().
18507     *
18508     * @ingroup Map
18509     */
18510    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18511
18512    /**
18513     * Get the zoom level of the map.
18514     *
18515     * @param obj The map object.
18516     * @return The current zoom level.
18517     *
18518     * This returns the current zoom level of the map object.
18519     *
18520     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18521     * (which is the default), the zoom level may be changed at any time by the
18522     * map object itself to account for map size and map viewport size.
18523     *
18524     * @see elm_map_zoom_set() for details.
18525     *
18526     * @ingroup Map
18527     */
18528    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18529
18530    /**
18531     * Set the zoom mode used by the map object.
18532     *
18533     * @param obj The map object.
18534     * @param mode The zoom mode of the map, being it one of
18535     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18536     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18537     *
18538     * This sets the zoom mode to manual or one of the automatic levels.
18539     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18540     * elm_map_zoom_set() and will stay at that level until changed by code
18541     * or until zoom mode is changed. This is the default mode.
18542     *
18543     * The Automatic modes will allow the map object to automatically
18544     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18545     * adjust zoom so the map fits inside the scroll frame with no pixels
18546     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18547     * ensure no pixels within the frame are left unfilled. Do not forget that
18548     * the valid sizes are 2^zoom, consequently the map may be smaller than
18549     * the scroller view.
18550     *
18551     * @see elm_map_zoom_set()
18552     *
18553     * @ingroup Map
18554     */
18555    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18556
18557    /**
18558     * Get the zoom mode used by the map object.
18559     *
18560     * @param obj The map object.
18561     * @return The zoom mode of the map, being it one of
18562     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18563     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18564     *
18565     * This function returns the current zoom mode used by the map object.
18566     *
18567     * @see elm_map_zoom_mode_set() for more details.
18568     *
18569     * @ingroup Map
18570     */
18571    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18572
18573    /**
18574     * Get the current coordinates of the map.
18575     *
18576     * @param obj The map object.
18577     * @param lon Pointer where to store longitude.
18578     * @param lat Pointer where to store latitude.
18579     *
18580     * This gets the current center coordinates of the map object. It can be
18581     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18582     *
18583     * @see elm_map_geo_region_bring_in()
18584     * @see elm_map_geo_region_show()
18585     *
18586     * @ingroup Map
18587     */
18588    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18589
18590    /**
18591     * Animatedly bring in given coordinates to the center of the map.
18592     *
18593     * @param obj The map object.
18594     * @param lon Longitude to center at.
18595     * @param lat Latitude to center at.
18596     *
18597     * This causes map to jump to the given @p lat and @p lon coordinates
18598     * and show it (by scrolling) in the center of the viewport, if it is not
18599     * already centered. This will use animation to do so and take a period
18600     * of time to complete.
18601     *
18602     * @see elm_map_geo_region_show() for a function to avoid animation.
18603     * @see elm_map_geo_region_get()
18604     *
18605     * @ingroup Map
18606     */
18607    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18608
18609    /**
18610     * Show the given coordinates at the center of the map, @b immediately.
18611     *
18612     * @param obj The map object.
18613     * @param lon Longitude to center at.
18614     * @param lat Latitude to center at.
18615     *
18616     * This causes map to @b redraw its viewport's contents to the
18617     * region contining the given @p lat and @p lon, that will be moved to the
18618     * center of the map.
18619     *
18620     * @see elm_map_geo_region_bring_in() for a function to move with animation.
18621     * @see elm_map_geo_region_get()
18622     *
18623     * @ingroup Map
18624     */
18625    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18626
18627    /**
18628     * Pause or unpause the map.
18629     *
18630     * @param obj The map object.
18631     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18632     * to unpause it.
18633     *
18634     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18635     * for map.
18636     *
18637     * The default is off.
18638     *
18639     * This will stop zooming using animation, changing zoom levels will
18640     * change instantly. This will stop any existing animations that are running.
18641     *
18642     * @see elm_map_paused_get()
18643     *
18644     * @ingroup Map
18645     */
18646    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18647
18648    /**
18649     * Get a value whether map is paused or not.
18650     *
18651     * @param obj The map object.
18652     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18653     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18654     *
18655     * This gets the current paused state for the map object.
18656     *
18657     * @see elm_map_paused_set() for details.
18658     *
18659     * @ingroup Map
18660     */
18661    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18662
18663    /**
18664     * Set to show markers during zoom level changes or not.
18665     *
18666     * @param obj The map object.
18667     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18668     * to show them.
18669     *
18670     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18671     * for map.
18672     *
18673     * The default is off.
18674     *
18675     * This will stop zooming using animation, changing zoom levels will
18676     * change instantly. This will stop any existing animations that are running.
18677     *
18678     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18679     * for the markers.
18680     *
18681     * The default  is off.
18682     *
18683     * Enabling it will force the map to stop displaying the markers during
18684     * zoom level changes. Set to on if you have a large number of markers.
18685     *
18686     * @see elm_map_paused_markers_get()
18687     *
18688     * @ingroup Map
18689     */
18690    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18691
18692    /**
18693     * Get a value whether markers will be displayed on zoom level changes or not
18694     *
18695     * @param obj The map object.
18696     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
18697     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
18698     *
18699     * This gets the current markers paused state for the map object.
18700     *
18701     * @see elm_map_paused_markers_set() for details.
18702     *
18703     * @ingroup Map
18704     */
18705    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18706
18707    /**
18708     * Get the information of downloading status.
18709     *
18710     * @param obj The map object.
18711     * @param try_num Pointer where to store number of tiles being downloaded.
18712     * @param finish_num Pointer where to store number of tiles successfully
18713     * downloaded.
18714     *
18715     * This gets the current downloading status for the map object, the number
18716     * of tiles being downloaded and the number of tiles already downloaded.
18717     *
18718     * @ingroup Map
18719     */
18720    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
18721
18722    /**
18723     * Convert a pixel coordinate (x,y) into a geographic coordinate
18724     * (longitude, latitude).
18725     *
18726     * @param obj The map object.
18727     * @param x the coordinate.
18728     * @param y the coordinate.
18729     * @param size the size in pixels of the map.
18730     * The map is a square and generally his size is : pow(2.0, zoom)*256.
18731     * @param lon Pointer where to store the longitude that correspond to x.
18732     * @param lat Pointer where to store the latitude that correspond to y.
18733     *
18734     * @note Origin pixel point is the top left corner of the viewport.
18735     * Map zoom and size are taken on account.
18736     *
18737     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
18738     *
18739     * @ingroup Map
18740     */
18741    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);
18742
18743    /**
18744     * Convert a geographic coordinate (longitude, latitude) into a pixel
18745     * coordinate (x, y).
18746     *
18747     * @param obj The map object.
18748     * @param lon the longitude.
18749     * @param lat the latitude.
18750     * @param size the size in pixels of the map. The map is a square
18751     * and generally his size is : pow(2.0, zoom)*256.
18752     * @param x Pointer where to store the horizontal pixel coordinate that
18753     * correspond to the longitude.
18754     * @param y Pointer where to store the vertical pixel coordinate that
18755     * correspond to the latitude.
18756     *
18757     * @note Origin pixel point is the top left corner of the viewport.
18758     * Map zoom and size are taken on account.
18759     *
18760     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
18761     *
18762     * @ingroup Map
18763     */
18764    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);
18765
18766    /**
18767     * Convert a geographic coordinate (longitude, latitude) into a name
18768     * (address).
18769     *
18770     * @param obj The map object.
18771     * @param lon the longitude.
18772     * @param lat the latitude.
18773     * @return name A #Elm_Map_Name handle for this coordinate.
18774     *
18775     * To get the string for this address, elm_map_name_address_get()
18776     * should be used.
18777     *
18778     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
18779     *
18780     * @ingroup Map
18781     */
18782    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18783
18784    /**
18785     * Convert a name (address) into a geographic coordinate
18786     * (longitude, latitude).
18787     *
18788     * @param obj The map object.
18789     * @param name The address.
18790     * @return name A #Elm_Map_Name handle for this address.
18791     *
18792     * To get the longitude and latitude, elm_map_name_region_get()
18793     * should be used.
18794     *
18795     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
18796     *
18797     * @ingroup Map
18798     */
18799    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
18800
18801    /**
18802     * Convert a pixel coordinate into a rotated pixel coordinate.
18803     *
18804     * @param obj The map object.
18805     * @param x horizontal coordinate of the point to rotate.
18806     * @param y vertical coordinate of the point to rotate.
18807     * @param cx rotation's center horizontal position.
18808     * @param cy rotation's center vertical position.
18809     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
18810     * @param xx Pointer where to store rotated x.
18811     * @param yy Pointer where to store rotated y.
18812     *
18813     * @ingroup Map
18814     */
18815    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);
18816
18817    /**
18818     * Add a new marker to the map object.
18819     *
18820     * @param obj The map object.
18821     * @param lon The longitude of the marker.
18822     * @param lat The latitude of the marker.
18823     * @param clas The class, to use when marker @b isn't grouped to others.
18824     * @param clas_group The class group, to use when marker is grouped to others
18825     * @param data The data passed to the callbacks.
18826     *
18827     * @return The created marker or @c NULL upon failure.
18828     *
18829     * A marker will be created and shown in a specific point of the map, defined
18830     * by @p lon and @p lat.
18831     *
18832     * It will be displayed using style defined by @p class when this marker
18833     * is displayed alone (not grouped). A new class can be created with
18834     * elm_map_marker_class_new().
18835     *
18836     * If the marker is grouped to other markers, it will be displayed with
18837     * style defined by @p class_group. Markers with the same group are grouped
18838     * if they are close. A new group class can be created with
18839     * elm_map_marker_group_class_new().
18840     *
18841     * Markers created with this method can be deleted with
18842     * elm_map_marker_remove().
18843     *
18844     * A marker can have associated content to be displayed by a bubble,
18845     * when a user click over it, as well as an icon. These objects will
18846     * be fetch using class' callback functions.
18847     *
18848     * @see elm_map_marker_class_new()
18849     * @see elm_map_marker_group_class_new()
18850     * @see elm_map_marker_remove()
18851     *
18852     * @ingroup Map
18853     */
18854    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);
18855
18856    /**
18857     * Set the maximum numbers of markers' content to be displayed in a group.
18858     *
18859     * @param obj The map object.
18860     * @param max The maximum numbers of items displayed in a bubble.
18861     *
18862     * A bubble will be displayed when the user clicks over the group,
18863     * and will place the content of markers that belong to this group
18864     * inside it.
18865     *
18866     * A group can have a long list of markers, consequently the creation
18867     * of the content of the bubble can be very slow.
18868     *
18869     * In order to avoid this, a maximum number of items is displayed
18870     * in a bubble.
18871     *
18872     * By default this number is 30.
18873     *
18874     * Marker with the same group class are grouped if they are close.
18875     *
18876     * @see elm_map_marker_add()
18877     *
18878     * @ingroup Map
18879     */
18880    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
18881
18882    /**
18883     * Remove a marker from the map.
18884     *
18885     * @param marker The marker to remove.
18886     *
18887     * @see elm_map_marker_add()
18888     *
18889     * @ingroup Map
18890     */
18891    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18892
18893    /**
18894     * Get the current coordinates of the marker.
18895     *
18896     * @param marker marker.
18897     * @param lat Pointer where to store the marker's latitude.
18898     * @param lon Pointer where to store the marker's longitude.
18899     *
18900     * These values are set when adding markers, with function
18901     * elm_map_marker_add().
18902     *
18903     * @see elm_map_marker_add()
18904     *
18905     * @ingroup Map
18906     */
18907    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
18908
18909    /**
18910     * Animatedly bring in given marker to the center of the map.
18911     *
18912     * @param marker The marker to center at.
18913     *
18914     * This causes map to jump to the given @p marker's coordinates
18915     * and show it (by scrolling) in the center of the viewport, if it is not
18916     * already centered. This will use animation to do so and take a period
18917     * of time to complete.
18918     *
18919     * @see elm_map_marker_show() for a function to avoid animation.
18920     * @see elm_map_marker_region_get()
18921     *
18922     * @ingroup Map
18923     */
18924    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18925
18926    /**
18927     * Show the given marker at the center of the map, @b immediately.
18928     *
18929     * @param marker The marker to center at.
18930     *
18931     * This causes map to @b redraw its viewport's contents to the
18932     * region contining the given @p marker's coordinates, that will be
18933     * moved to the center of the map.
18934     *
18935     * @see elm_map_marker_bring_in() for a function to move with animation.
18936     * @see elm_map_markers_list_show() if more than one marker need to be
18937     * displayed.
18938     * @see elm_map_marker_region_get()
18939     *
18940     * @ingroup Map
18941     */
18942    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18943
18944    /**
18945     * Move and zoom the map to display a list of markers.
18946     *
18947     * @param markers A list of #Elm_Map_Marker handles.
18948     *
18949     * The map will be centered on the center point of the markers in the list.
18950     * Then the map will be zoomed in order to fit the markers using the maximum
18951     * zoom which allows display of all the markers.
18952     *
18953     * @warning All the markers should belong to the same map object.
18954     *
18955     * @see elm_map_marker_show() to show a single marker.
18956     * @see elm_map_marker_bring_in()
18957     *
18958     * @ingroup Map
18959     */
18960    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
18961
18962    /**
18963     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
18964     *
18965     * @param marker The marker wich content should be returned.
18966     * @return Return the evas object if it exists, else @c NULL.
18967     *
18968     * To set callback function #ElmMapMarkerGetFunc for the marker class,
18969     * elm_map_marker_class_get_cb_set() should be used.
18970     *
18971     * This content is what will be inside the bubble that will be displayed
18972     * when an user clicks over the marker.
18973     *
18974     * This returns the actual Evas object used to be placed inside
18975     * the bubble. This may be @c NULL, as it may
18976     * not have been created or may have been deleted, at any time, by
18977     * the map. <b>Do not modify this object</b> (move, resize,
18978     * show, hide, etc.), as the map is controlling it. This
18979     * function is for querying, emitting custom signals or hooking
18980     * lower level callbacks for events on that object. Do not delete
18981     * this object under any circumstances.
18982     *
18983     * @ingroup Map
18984     */
18985    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18986
18987    /**
18988     * Update the marker
18989     *
18990     * @param marker The marker to be updated.
18991     *
18992     * If a content is set to this marker, it will call function to delete it,
18993     * #ElmMapMarkerDelFunc, and then will fetch the content again with
18994     * #ElmMapMarkerGetFunc.
18995     *
18996     * These functions are set for the marker class with
18997     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
18998     *
18999     * @ingroup Map
19000     */
19001    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19002
19003    /**
19004     * Close all the bubbles opened by the user.
19005     *
19006     * @param obj The map object.
19007     *
19008     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19009     * when the user clicks on a marker.
19010     *
19011     * This functions is set for the marker class with
19012     * elm_map_marker_class_get_cb_set().
19013     *
19014     * @ingroup Map
19015     */
19016    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19017
19018    /**
19019     * Create a new group class.
19020     *
19021     * @param obj The map object.
19022     * @return Returns the new group class.
19023     *
19024     * Each marker must be associated to a group class. Markers in the same
19025     * group are grouped if they are close.
19026     *
19027     * The group class defines the style of the marker when a marker is grouped
19028     * to others markers. When it is alone, another class will be used.
19029     *
19030     * A group class will need to be provided when creating a marker with
19031     * elm_map_marker_add().
19032     *
19033     * Some properties and functions can be set by class, as:
19034     * - style, with elm_map_group_class_style_set()
19035     * - data - to be associated to the group class. It can be set using
19036     *   elm_map_group_class_data_set().
19037     * - min zoom to display markers, set with
19038     *   elm_map_group_class_zoom_displayed_set().
19039     * - max zoom to group markers, set using
19040     *   elm_map_group_class_zoom_grouped_set().
19041     * - visibility - set if markers will be visible or not, set with
19042     *   elm_map_group_class_hide_set().
19043     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19044     *   It can be set using elm_map_group_class_icon_cb_set().
19045     *
19046     * @see elm_map_marker_add()
19047     * @see elm_map_group_class_style_set()
19048     * @see elm_map_group_class_data_set()
19049     * @see elm_map_group_class_zoom_displayed_set()
19050     * @see elm_map_group_class_zoom_grouped_set()
19051     * @see elm_map_group_class_hide_set()
19052     * @see elm_map_group_class_icon_cb_set()
19053     *
19054     * @ingroup Map
19055     */
19056    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19057
19058    /**
19059     * Set the marker's style of a group class.
19060     *
19061     * @param clas The group class.
19062     * @param style The style to be used by markers.
19063     *
19064     * Each marker must be associated to a group class, and will use the style
19065     * defined by such class when grouped to other markers.
19066     *
19067     * The following styles are provided by default theme:
19068     * @li @c radio - blue circle
19069     * @li @c radio2 - green circle
19070     * @li @c empty
19071     *
19072     * @see elm_map_group_class_new() for more details.
19073     * @see elm_map_marker_add()
19074     *
19075     * @ingroup Map
19076     */
19077    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19078
19079    /**
19080     * Set the icon callback function of a group class.
19081     *
19082     * @param clas The group class.
19083     * @param icon_get The callback function that will return the icon.
19084     *
19085     * Each marker must be associated to a group class, and it can display a
19086     * custom icon. The function @p icon_get must return this icon.
19087     *
19088     * @see elm_map_group_class_new() for more details.
19089     * @see elm_map_marker_add()
19090     *
19091     * @ingroup Map
19092     */
19093    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19094
19095    /**
19096     * Set the data associated to the group class.
19097     *
19098     * @param clas The group class.
19099     * @param data The new user data.
19100     *
19101     * This data will be passed for callback functions, like icon get callback,
19102     * that can be set with elm_map_group_class_icon_cb_set().
19103     *
19104     * If a data was previously set, the object will lose the pointer for it,
19105     * so if needs to be freed, you must do it yourself.
19106     *
19107     * @see elm_map_group_class_new() for more details.
19108     * @see elm_map_group_class_icon_cb_set()
19109     * @see elm_map_marker_add()
19110     *
19111     * @ingroup Map
19112     */
19113    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19114
19115    /**
19116     * Set the minimum zoom from where the markers are displayed.
19117     *
19118     * @param clas The group class.
19119     * @param zoom The minimum zoom.
19120     *
19121     * Markers only will be displayed when the map is displayed at @p zoom
19122     * or bigger.
19123     *
19124     * @see elm_map_group_class_new() for more details.
19125     * @see elm_map_marker_add()
19126     *
19127     * @ingroup Map
19128     */
19129    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19130
19131    /**
19132     * Set the zoom from where the markers are no more grouped.
19133     *
19134     * @param clas The group class.
19135     * @param zoom The maximum zoom.
19136     *
19137     * Markers only will be grouped when the map is displayed at
19138     * less than @p zoom.
19139     *
19140     * @see elm_map_group_class_new() for more details.
19141     * @see elm_map_marker_add()
19142     *
19143     * @ingroup Map
19144     */
19145    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19146
19147    /**
19148     * Set if the markers associated to the group class @clas are hidden or not.
19149     *
19150     * @param clas The group class.
19151     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19152     * to show them.
19153     *
19154     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19155     * is to show them.
19156     *
19157     * @ingroup Map
19158     */
19159    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19160
19161    /**
19162     * Create a new marker class.
19163     *
19164     * @param obj The map object.
19165     * @return Returns the new group class.
19166     *
19167     * Each marker must be associated to a class.
19168     *
19169     * The marker class defines the style of the marker when a marker is
19170     * displayed alone, i.e., not grouped to to others markers. When grouped
19171     * it will use group class style.
19172     *
19173     * A marker class will need to be provided when creating a marker with
19174     * elm_map_marker_add().
19175     *
19176     * Some properties and functions can be set by class, as:
19177     * - style, with elm_map_marker_class_style_set()
19178     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19179     *   It can be set using elm_map_marker_class_icon_cb_set().
19180     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19181     *   Set using elm_map_marker_class_get_cb_set().
19182     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19183     *   Set using elm_map_marker_class_del_cb_set().
19184     *
19185     * @see elm_map_marker_add()
19186     * @see elm_map_marker_class_style_set()
19187     * @see elm_map_marker_class_icon_cb_set()
19188     * @see elm_map_marker_class_get_cb_set()
19189     * @see elm_map_marker_class_del_cb_set()
19190     *
19191     * @ingroup Map
19192     */
19193    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19194
19195    /**
19196     * Set the marker's style of a marker class.
19197     *
19198     * @param clas The marker class.
19199     * @param style The style to be used by markers.
19200     *
19201     * Each marker must be associated to a marker class, and will use the style
19202     * defined by such class when alone, i.e., @b not grouped to other markers.
19203     *
19204     * The following styles are provided by default theme:
19205     * @li @c radio
19206     * @li @c radio2
19207     * @li @c empty
19208     *
19209     * @see elm_map_marker_class_new() for more details.
19210     * @see elm_map_marker_add()
19211     *
19212     * @ingroup Map
19213     */
19214    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19215
19216    /**
19217     * Set the icon callback function of a marker class.
19218     *
19219     * @param clas The marker class.
19220     * @param icon_get The callback function that will return the icon.
19221     *
19222     * Each marker must be associated to a marker class, and it can display a
19223     * custom icon. The function @p icon_get must return this icon.
19224     *
19225     * @see elm_map_marker_class_new() for more details.
19226     * @see elm_map_marker_add()
19227     *
19228     * @ingroup Map
19229     */
19230    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19231
19232    /**
19233     * Set the bubble content callback function of a marker class.
19234     *
19235     * @param clas The marker class.
19236     * @param get The callback function that will return the content.
19237     *
19238     * Each marker must be associated to a marker class, and it can display a
19239     * a content on a bubble that opens when the user click over the marker.
19240     * The function @p get must return this content object.
19241     *
19242     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19243     * can be used.
19244     *
19245     * @see elm_map_marker_class_new() for more details.
19246     * @see elm_map_marker_class_del_cb_set()
19247     * @see elm_map_marker_add()
19248     *
19249     * @ingroup Map
19250     */
19251    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19252
19253    /**
19254     * Set the callback function used to delete bubble content of a marker class.
19255     *
19256     * @param clas The marker class.
19257     * @param del The callback function that will delete the content.
19258     *
19259     * Each marker must be associated to a marker class, and it can display a
19260     * a content on a bubble that opens when the user click over the marker.
19261     * The function to return such content can be set with
19262     * elm_map_marker_class_get_cb_set().
19263     *
19264     * If this content must be freed, a callback function need to be
19265     * set for that task with this function.
19266     *
19267     * If this callback is defined it will have to delete (or not) the
19268     * object inside, but if the callback is not defined the object will be
19269     * destroyed with evas_object_del().
19270     *
19271     * @see elm_map_marker_class_new() for more details.
19272     * @see elm_map_marker_class_get_cb_set()
19273     * @see elm_map_marker_add()
19274     *
19275     * @ingroup Map
19276     */
19277    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19278
19279    /**
19280     * Get the list of available sources.
19281     *
19282     * @param obj The map object.
19283     * @return The source names list.
19284     *
19285     * It will provide a list with all available sources, that can be set as
19286     * current source with elm_map_source_name_set(), or get with
19287     * elm_map_source_name_get().
19288     *
19289     * Available sources:
19290     * @li "Mapnik"
19291     * @li "Osmarender"
19292     * @li "CycleMap"
19293     * @li "Maplint"
19294     *
19295     * @see elm_map_source_name_set() for more details.
19296     * @see elm_map_source_name_get()
19297     *
19298     * @ingroup Map
19299     */
19300    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19301
19302    /**
19303     * Set the source of the map.
19304     *
19305     * @param obj The map object.
19306     * @param source The source to be used.
19307     *
19308     * Map widget retrieves images that composes the map from a web service.
19309     * This web service can be set with this method.
19310     *
19311     * A different service can return a different maps with different
19312     * information and it can use different zoom values.
19313     *
19314     * The @p source_name need to match one of the names provided by
19315     * elm_map_source_names_get().
19316     *
19317     * The current source can be get using elm_map_source_name_get().
19318     *
19319     * @see elm_map_source_names_get()
19320     * @see elm_map_source_name_get()
19321     *
19322     *
19323     * @ingroup Map
19324     */
19325    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19326
19327    /**
19328     * Get the name of currently used source.
19329     *
19330     * @param obj The map object.
19331     * @return Returns the name of the source in use.
19332     *
19333     * @see elm_map_source_name_set() for more details.
19334     *
19335     * @ingroup Map
19336     */
19337    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19338
19339    /**
19340     * Set the source of the route service to be used by the map.
19341     *
19342     * @param obj The map object.
19343     * @param source The route service to be used, being it one of
19344     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19345     * and #ELM_MAP_ROUTE_SOURCE_ORS.
19346     *
19347     * Each one has its own algorithm, so the route retrieved may
19348     * differ depending on the source route. Now, only the default is working.
19349     *
19350     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19351     * http://www.yournavigation.org/.
19352     *
19353     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19354     * assumptions. Its routing core is based on Contraction Hierarchies.
19355     *
19356     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19357     *
19358     * @see elm_map_route_source_get().
19359     *
19360     * @ingroup Map
19361     */
19362    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19363
19364    /**
19365     * Get the current route source.
19366     *
19367     * @param obj The map object.
19368     * @return The source of the route service used by the map.
19369     *
19370     * @see elm_map_route_source_set() for details.
19371     *
19372     * @ingroup Map
19373     */
19374    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19375
19376    /**
19377     * Set the minimum zoom of the source.
19378     *
19379     * @param obj The map object.
19380     * @param zoom New minimum zoom value to be used.
19381     *
19382     * By default, it's 0.
19383     *
19384     * @ingroup Map
19385     */
19386    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19387
19388    /**
19389     * Get the minimum zoom of the source.
19390     *
19391     * @param obj The map object.
19392     * @return Returns the minimum zoom of the source.
19393     *
19394     * @see elm_map_source_zoom_min_set() for details.
19395     *
19396     * @ingroup Map
19397     */
19398    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19399
19400    /**
19401     * Set the maximum zoom of the source.
19402     *
19403     * @param obj The map object.
19404     * @param zoom New maximum zoom value to be used.
19405     *
19406     * By default, it's 18.
19407     *
19408     * @ingroup Map
19409     */
19410    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19411
19412    /**
19413     * Get the maximum zoom of the source.
19414     *
19415     * @param obj The map object.
19416     * @return Returns the maximum zoom of the source.
19417     *
19418     * @see elm_map_source_zoom_min_set() for details.
19419     *
19420     * @ingroup Map
19421     */
19422    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19423
19424    /**
19425     * Set the user agent used by the map object to access routing services.
19426     *
19427     * @param obj The map object.
19428     * @param user_agent The user agent to be used by the map.
19429     *
19430     * User agent is a client application implementing a network protocol used
19431     * in communications within a client–server distributed computing system
19432     *
19433     * The @p user_agent identification string will transmitted in a header
19434     * field @c User-Agent.
19435     *
19436     * @see elm_map_user_agent_get()
19437     *
19438     * @ingroup Map
19439     */
19440    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19441
19442    /**
19443     * Get the user agent used by the map object.
19444     *
19445     * @param obj The map object.
19446     * @return The user agent identification string used by the map.
19447     *
19448     * @see elm_map_user_agent_set() for details.
19449     *
19450     * @ingroup Map
19451     */
19452    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19453
19454    /**
19455     * Add a new route to the map object.
19456     *
19457     * @param obj The map object.
19458     * @param type The type of transport to be considered when tracing a route.
19459     * @param method The routing method, what should be priorized.
19460     * @param flon The start longitude.
19461     * @param flat The start latitude.
19462     * @param tlon The destination longitude.
19463     * @param tlat The destination latitude.
19464     *
19465     * @return The created route or @c NULL upon failure.
19466     *
19467     * A route will be traced by point on coordinates (@p flat, @p flon)
19468     * to point on coordinates (@p tlat, @p tlon), using the route service
19469     * set with elm_map_route_source_set().
19470     *
19471     * It will take @p type on consideration to define the route,
19472     * depending if the user will be walking or driving, the route may vary.
19473     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19474     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19475     *
19476     * Another parameter is what the route should priorize, the minor distance
19477     * or the less time to be spend on the route. So @p method should be one
19478     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19479     *
19480     * Routes created with this method can be deleted with
19481     * elm_map_route_remove(), colored with elm_map_route_color_set(),
19482     * and distance can be get with elm_map_route_distance_get().
19483     *
19484     * @see elm_map_route_remove()
19485     * @see elm_map_route_color_set()
19486     * @see elm_map_route_distance_get()
19487     * @see elm_map_route_source_set()
19488     *
19489     * @ingroup Map
19490     */
19491    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);
19492
19493    /**
19494     * Remove a route from the map.
19495     *
19496     * @param route The route to remove.
19497     *
19498     * @see elm_map_route_add()
19499     *
19500     * @ingroup Map
19501     */
19502    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19503
19504    /**
19505     * Set the route color.
19506     *
19507     * @param route The route object.
19508     * @param r Red channel value, from 0 to 255.
19509     * @param g Green channel value, from 0 to 255.
19510     * @param b Blue channel value, from 0 to 255.
19511     * @param a Alpha channel value, from 0 to 255.
19512     *
19513     * It uses an additive color model, so each color channel represents
19514     * how much of each primary colors must to be used. 0 represents
19515     * ausence of this color, so if all of the three are set to 0,
19516     * the color will be black.
19517     *
19518     * These component values should be integers in the range 0 to 255,
19519     * (single 8-bit byte).
19520     *
19521     * This sets the color used for the route. By default, it is set to
19522     * solid red (r = 255, g = 0, b = 0, a = 255).
19523     *
19524     * For alpha channel, 0 represents completely transparent, and 255, opaque.
19525     *
19526     * @see elm_map_route_color_get()
19527     *
19528     * @ingroup Map
19529     */
19530    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19531
19532    /**
19533     * Get the route color.
19534     *
19535     * @param route The route object.
19536     * @param r Pointer where to store the red channel value.
19537     * @param g Pointer where to store the green channel value.
19538     * @param b Pointer where to store the blue channel value.
19539     * @param a Pointer where to store the alpha channel value.
19540     *
19541     * @see elm_map_route_color_set() for details.
19542     *
19543     * @ingroup Map
19544     */
19545    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19546
19547    /**
19548     * Get the route distance in kilometers.
19549     *
19550     * @param route The route object.
19551     * @return The distance of route (unit : km).
19552     *
19553     * @ingroup Map
19554     */
19555    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19556
19557    /**
19558     * Get the information of route nodes.
19559     *
19560     * @param route The route object.
19561     * @return Returns a string with the nodes of route.
19562     *
19563     * @ingroup Map
19564     */
19565    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19566
19567    /**
19568     * Get the information of route waypoint.
19569     *
19570     * @param route the route object.
19571     * @return Returns a string with information about waypoint of route.
19572     *
19573     * @ingroup Map
19574     */
19575    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19576
19577    /**
19578     * Get the address of the name.
19579     *
19580     * @param name The name handle.
19581     * @return Returns the address string of @p name.
19582     *
19583     * This gets the coordinates of the @p name, created with one of the
19584     * conversion functions.
19585     *
19586     * @see elm_map_utils_convert_name_into_coord()
19587     * @see elm_map_utils_convert_coord_into_name()
19588     *
19589     * @ingroup Map
19590     */
19591    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19592
19593    /**
19594     * Get the current coordinates of the name.
19595     *
19596     * @param name The name handle.
19597     * @param lat Pointer where to store the latitude.
19598     * @param lon Pointer where to store The longitude.
19599     *
19600     * This gets the coordinates of the @p name, created with one of the
19601     * conversion functions.
19602     *
19603     * @see elm_map_utils_convert_name_into_coord()
19604     * @see elm_map_utils_convert_coord_into_name()
19605     *
19606     * @ingroup Map
19607     */
19608    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19609
19610    /**
19611     * Remove a name from the map.
19612     *
19613     * @param name The name to remove.
19614     *
19615     * Basically the struct handled by @p name will be freed, so convertions
19616     * between address and coordinates will be lost.
19617     *
19618     * @see elm_map_utils_convert_name_into_coord()
19619     * @see elm_map_utils_convert_coord_into_name()
19620     *
19621     * @ingroup Map
19622     */
19623    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19624
19625    /**
19626     * Rotate the map.
19627     *
19628     * @param obj The map object.
19629     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19630     * @param cx Rotation's center horizontal position.
19631     * @param cy Rotation's center vertical position.
19632     *
19633     * @see elm_map_rotate_get()
19634     *
19635     * @ingroup Map
19636     */
19637    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19638
19639    /**
19640     * Get the rotate degree of the map
19641     *
19642     * @param obj The map object
19643     * @param degree Pointer where to store degrees from 0.0 to 360.0
19644     * to rotate arount Z axis.
19645     * @param cx Pointer where to store rotation's center horizontal position.
19646     * @param cy Pointer where to store rotation's center vertical position.
19647     *
19648     * @see elm_map_rotate_set() to set map rotation.
19649     *
19650     * @ingroup Map
19651     */
19652    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);
19653
19654    /**
19655     * Enable or disable mouse wheel to be used to zoom in / out the map.
19656     *
19657     * @param obj The map object.
19658     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19659     * to enable it.
19660     *
19661     * Mouse wheel can be used for the user to zoom in or zoom out the map.
19662     *
19663     * It's disabled by default.
19664     *
19665     * @see elm_map_wheel_disabled_get()
19666     *
19667     * @ingroup Map
19668     */
19669    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19670
19671    /**
19672     * Get a value whether mouse wheel is enabled or not.
19673     *
19674     * @param obj The map object.
19675     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19676     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19677     *
19678     * Mouse wheel can be used for the user to zoom in or zoom out the map.
19679     *
19680     * @see elm_map_wheel_disabled_set() for details.
19681     *
19682     * @ingroup Map
19683     */
19684    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19685
19686 #ifdef ELM_EMAP
19687    /**
19688     * Add a track on the map
19689     *
19690     * @param obj The map object.
19691     * @param emap The emap route object.
19692     * @return The route object. This is an elm object of type Route.
19693     *
19694     * @see elm_route_add() for details.
19695     *
19696     * @ingroup Map
19697     */
19698    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
19699 #endif
19700
19701    /**
19702     * Remove a track from the map
19703     *
19704     * @param obj The map object.
19705     * @param route The track to remove.
19706     *
19707     * @ingroup Map
19708     */
19709    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
19710
19711    /**
19712     * @}
19713     */
19714
19715    /* Route */
19716    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
19717 #ifdef ELM_EMAP
19718    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
19719 #endif
19720    EAPI double elm_route_lon_min_get(Evas_Object *obj);
19721    EAPI double elm_route_lat_min_get(Evas_Object *obj);
19722    EAPI double elm_route_lon_max_get(Evas_Object *obj);
19723    EAPI double elm_route_lat_max_get(Evas_Object *obj);
19724
19725
19726    /**
19727     * @defgroup Panel Panel
19728     *
19729     * @image html img/widget/panel/preview-00.png
19730     * @image latex img/widget/panel/preview-00.eps
19731     *
19732     * @brief A panel is a type of animated container that contains subobjects.
19733     * It can be expanded or contracted by clicking the button on it's edge.
19734     *
19735     * Orientations are as follows:
19736     * @li ELM_PANEL_ORIENT_TOP
19737     * @li ELM_PANEL_ORIENT_LEFT
19738     * @li ELM_PANEL_ORIENT_RIGHT
19739     *
19740     * @ref tutorial_panel shows one way to use this widget.
19741     * @{
19742     */
19743    typedef enum _Elm_Panel_Orient
19744      {
19745         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
19746         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
19747         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
19748         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
19749      } Elm_Panel_Orient;
19750    /**
19751     * @brief Adds a panel object
19752     *
19753     * @param parent The parent object
19754     *
19755     * @return The panel object, or NULL on failure
19756     */
19757    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19758    /**
19759     * @brief Sets the orientation of the panel
19760     *
19761     * @param parent The parent object
19762     * @param orient The panel orientation. Can be one of the following:
19763     * @li ELM_PANEL_ORIENT_TOP
19764     * @li ELM_PANEL_ORIENT_LEFT
19765     * @li ELM_PANEL_ORIENT_RIGHT
19766     *
19767     * Sets from where the panel will (dis)appear.
19768     */
19769    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
19770    /**
19771     * @brief Get the orientation of the panel.
19772     *
19773     * @param obj The panel object
19774     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
19775     */
19776    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19777    /**
19778     * @brief Set the content of the panel.
19779     *
19780     * @param obj The panel object
19781     * @param content The panel content
19782     *
19783     * Once the content object is set, a previously set one will be deleted.
19784     * If you want to keep that old content object, use the
19785     * elm_panel_content_unset() function.
19786     */
19787    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19788    /**
19789     * @brief Get the content of the panel.
19790     *
19791     * @param obj The panel object
19792     * @return The content that is being used
19793     *
19794     * Return the content object which is set for this widget.
19795     *
19796     * @see elm_panel_content_set()
19797     */
19798    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19799    /**
19800     * @brief Unset the content of the panel.
19801     *
19802     * @param obj The panel object
19803     * @return The content that was being used
19804     *
19805     * Unparent and return the content object which was set for this widget.
19806     *
19807     * @see elm_panel_content_set()
19808     */
19809    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19810    /**
19811     * @brief Set the state of the panel.
19812     *
19813     * @param obj The panel object
19814     * @param hidden If true, the panel will run the animation to contract
19815     */
19816    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
19817    /**
19818     * @brief Get the state of the panel.
19819     *
19820     * @param obj The panel object
19821     * @param hidden If true, the panel is in the "hide" state
19822     */
19823    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19824    /**
19825     * @brief Toggle the hidden state of the panel from code
19826     *
19827     * @param obj The panel object
19828     */
19829    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
19830    /**
19831     * @}
19832     */
19833
19834    /**
19835     * @defgroup Panes Panes
19836     * @ingroup Elementary
19837     *
19838     * @image html img/widget/panes/preview-00.png
19839     * @image latex img/widget/panes/preview-00.eps width=\textwidth
19840     *
19841     * @image html img/panes.png
19842     * @image latex img/panes.eps width=\textwidth
19843     *
19844     * The panes adds a dragable bar between two contents. When dragged
19845     * this bar will resize contents size.
19846     *
19847     * Panes can be displayed vertically or horizontally, and contents
19848     * size proportion can be customized (homogeneous by default).
19849     *
19850     * Smart callbacks one can listen to:
19851     * - "press" - The panes has been pressed (button wasn't released yet).
19852     * - "unpressed" - The panes was released after being pressed.
19853     * - "clicked" - The panes has been clicked>
19854     * - "clicked,double" - The panes has been double clicked
19855     *
19856     * Available styles for it:
19857     * - @c "default"
19858     *
19859     * Here is an example on its usage:
19860     * @li @ref panes_example
19861     */
19862
19863    /**
19864     * @addtogroup Panes
19865     * @{
19866     */
19867
19868    /**
19869     * Add a new panes widget to the given parent Elementary
19870     * (container) object.
19871     *
19872     * @param parent The parent object.
19873     * @return a new panes widget handle or @c NULL, on errors.
19874     *
19875     * This function inserts a new panes widget on the canvas.
19876     *
19877     * @ingroup Panes
19878     */
19879    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19880
19881    /**
19882     * Set the left content of the panes widget.
19883     *
19884     * @param obj The panes object.
19885     * @param content The new left content object.
19886     *
19887     * Once the content object is set, a previously set one will be deleted.
19888     * If you want to keep that old content object, use the
19889     * elm_panes_content_left_unset() function.
19890     *
19891     * If panes is displayed vertically, left content will be displayed at
19892     * top.
19893     *
19894     * @see elm_panes_content_left_get()
19895     * @see elm_panes_content_right_set() to set content on the other side.
19896     *
19897     * @ingroup Panes
19898     */
19899    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19900
19901    /**
19902     * Set the right content of the panes widget.
19903     *
19904     * @param obj The panes object.
19905     * @param content The new right content object.
19906     *
19907     * Once the content object is set, a previously set one will be deleted.
19908     * If you want to keep that old content object, use the
19909     * elm_panes_content_right_unset() function.
19910     *
19911     * If panes is displayed vertically, left content will be displayed at
19912     * bottom.
19913     *
19914     * @see elm_panes_content_right_get()
19915     * @see elm_panes_content_left_set() to set content on the other side.
19916     *
19917     * @ingroup Panes
19918     */
19919    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19920
19921    /**
19922     * Get the left content of the panes.
19923     *
19924     * @param obj The panes object.
19925     * @return The left content object that is being used.
19926     *
19927     * Return the left content object which is set for this widget.
19928     *
19929     * @see elm_panes_content_left_set() for details.
19930     *
19931     * @ingroup Panes
19932     */
19933    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19934
19935    /**
19936     * Get the right content of the panes.
19937     *
19938     * @param obj The panes object
19939     * @return The right content object that is being used
19940     *
19941     * Return the right content object which is set for this widget.
19942     *
19943     * @see elm_panes_content_right_set() for details.
19944     *
19945     * @ingroup Panes
19946     */
19947    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19948
19949    /**
19950     * Unset the left content used for the panes.
19951     *
19952     * @param obj The panes object.
19953     * @return The left content object that was being used.
19954     *
19955     * Unparent and return the left content object which was set for this widget.
19956     *
19957     * @see elm_panes_content_left_set() for details.
19958     * @see elm_panes_content_left_get().
19959     *
19960     * @ingroup Panes
19961     */
19962    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19963
19964    /**
19965     * Unset the right content used for the panes.
19966     *
19967     * @param obj The panes object.
19968     * @return The right content object that was being used.
19969     *
19970     * Unparent and return the right content object which was set for this
19971     * widget.
19972     *
19973     * @see elm_panes_content_right_set() for details.
19974     * @see elm_panes_content_right_get().
19975     *
19976     * @ingroup Panes
19977     */
19978    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19979
19980    /**
19981     * Get the size proportion of panes widget's left side.
19982     *
19983     * @param obj The panes object.
19984     * @return float value between 0.0 and 1.0 representing size proportion
19985     * of left side.
19986     *
19987     * @see elm_panes_content_left_size_set() for more details.
19988     *
19989     * @ingroup Panes
19990     */
19991    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19992
19993    /**
19994     * Set the size proportion of panes widget's left side.
19995     *
19996     * @param obj The panes object.
19997     * @param size Value between 0.0 and 1.0 representing size proportion
19998     * of left side.
19999     *
20000     * By default it's homogeneous, i.e., both sides have the same size.
20001     *
20002     * If something different is required, it can be set with this function.
20003     * For example, if the left content should be displayed over
20004     * 75% of the panes size, @p size should be passed as @c 0.75.
20005     * This way, right content will be resized to 25% of panes size.
20006     *
20007     * If displayed vertically, left content is displayed at top, and
20008     * right content at bottom.
20009     *
20010     * @note This proportion will change when user drags the panes bar.
20011     *
20012     * @see elm_panes_content_left_size_get()
20013     *
20014     * @ingroup Panes
20015     */
20016    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20017
20018   /**
20019    * Set the orientation of a given panes widget.
20020    *
20021    * @param obj The panes object.
20022    * @param horizontal Use @c EINA_TRUE to make @p obj to be
20023    * @b horizontal, @c EINA_FALSE to make it @b vertical.
20024    *
20025    * Use this function to change how your panes is to be
20026    * disposed: vertically or horizontally.
20027    *
20028    * By default it's displayed horizontally.
20029    *
20030    * @see elm_panes_horizontal_get()
20031    *
20032    * @ingroup Panes
20033    */
20034    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20035
20036    /**
20037     * Retrieve the orientation of a given panes widget.
20038     *
20039     * @param obj The panes object.
20040     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20041     * @c EINA_FALSE if it's @b vertical (and on errors).
20042     *
20043     * @see elm_panes_horizontal_set() for more details.
20044     *
20045     * @ingroup Panes
20046     */
20047    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20048
20049    /**
20050     * @}
20051     */
20052
20053    /**
20054     * @defgroup Flip Flip
20055     *
20056     * @image html img/widget/flip/preview-00.png
20057     * @image latex img/widget/flip/preview-00.eps
20058     *
20059     * This widget holds 2 content objects(Evas_Object): one on the front and one
20060     * on the back. It allows you to flip from front to back and vice-versa using
20061     * various animations.
20062     *
20063     * If either the front or back contents are not set the flip will treat that
20064     * as transparent. So if you wore to set the front content but not the back,
20065     * and then call elm_flip_go() you would see whatever is below the flip.
20066     *
20067     * For a list of supported animations see elm_flip_go().
20068     *
20069     * Signals that you can add callbacks for are:
20070     * "animate,begin" - when a flip animation was started
20071     * "animate,done" - when a flip animation is finished
20072     *
20073     * @ref tutorial_flip show how to use most of the API.
20074     *
20075     * @{
20076     */
20077    typedef enum _Elm_Flip_Mode
20078      {
20079         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20080         ELM_FLIP_ROTATE_X_CENTER_AXIS,
20081         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20082         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20083         ELM_FLIP_CUBE_LEFT,
20084         ELM_FLIP_CUBE_RIGHT,
20085         ELM_FLIP_CUBE_UP,
20086         ELM_FLIP_CUBE_DOWN,
20087         ELM_FLIP_PAGE_LEFT,
20088         ELM_FLIP_PAGE_RIGHT,
20089         ELM_FLIP_PAGE_UP,
20090         ELM_FLIP_PAGE_DOWN
20091      } Elm_Flip_Mode;
20092    typedef enum _Elm_Flip_Interaction
20093      {
20094         ELM_FLIP_INTERACTION_NONE,
20095         ELM_FLIP_INTERACTION_ROTATE,
20096         ELM_FLIP_INTERACTION_CUBE,
20097         ELM_FLIP_INTERACTION_PAGE
20098      } Elm_Flip_Interaction;
20099    typedef enum _Elm_Flip_Direction
20100      {
20101         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20102         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20103         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20104         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20105      } Elm_Flip_Direction;
20106    /**
20107     * @brief Add a new flip to the parent
20108     *
20109     * @param parent The parent object
20110     * @return The new object or NULL if it cannot be created
20111     */
20112    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20113    /**
20114     * @brief Set the front content of the flip widget.
20115     *
20116     * @param obj The flip object
20117     * @param content The new front content object
20118     *
20119     * Once the content object is set, a previously set one will be deleted.
20120     * If you want to keep that old content object, use the
20121     * elm_flip_content_front_unset() function.
20122     */
20123    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20124    /**
20125     * @brief Set the back content of the flip widget.
20126     *
20127     * @param obj The flip object
20128     * @param content The new back content object
20129     *
20130     * Once the content object is set, a previously set one will be deleted.
20131     * If you want to keep that old content object, use the
20132     * elm_flip_content_back_unset() function.
20133     */
20134    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20135    /**
20136     * @brief Get the front content used for the flip
20137     *
20138     * @param obj The flip object
20139     * @return The front content object that is being used
20140     *
20141     * Return the front content object which is set for this widget.
20142     */
20143    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20144    /**
20145     * @brief Get the back content used for the flip
20146     *
20147     * @param obj The flip object
20148     * @return The back content object that is being used
20149     *
20150     * Return the back content object which is set for this widget.
20151     */
20152    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20153    /**
20154     * @brief Unset the front content used for the flip
20155     *
20156     * @param obj The flip object
20157     * @return The front content object that was being used
20158     *
20159     * Unparent and return the front content object which was set for this widget.
20160     */
20161    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20162    /**
20163     * @brief Unset the back content used for the flip
20164     *
20165     * @param obj The flip object
20166     * @return The back content object that was being used
20167     *
20168     * Unparent and return the back content object which was set for this widget.
20169     */
20170    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20171    /**
20172     * @brief Get flip front visibility state
20173     *
20174     * @param obj The flip objct
20175     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20176     * showing.
20177     */
20178    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20179    /**
20180     * @brief Set flip perspective
20181     *
20182     * @param obj The flip object
20183     * @param foc The coordinate to set the focus on
20184     * @param x The X coordinate
20185     * @param y The Y coordinate
20186     *
20187     * @warning This function currently does nothing.
20188     */
20189    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20190    /**
20191     * @brief Runs the flip animation
20192     *
20193     * @param obj The flip object
20194     * @param mode The mode type
20195     *
20196     * Flips the front and back contents using the @p mode animation. This
20197     * efectively hides the currently visible content and shows the hidden one.
20198     *
20199     * There a number of possible animations to use for the flipping:
20200     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20201     * around a horizontal axis in the middle of its height, the other content
20202     * is shown as the other side of the flip.
20203     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20204     * around a vertical axis in the middle of its width, the other content is
20205     * shown as the other side of the flip.
20206     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20207     * around a diagonal axis in the middle of its width, the other content is
20208     * shown as the other side of the flip.
20209     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20210     * around a diagonal axis in the middle of its height, the other content is
20211     * shown as the other side of the flip.
20212     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20213     * as if the flip was a cube, the other content is show as the right face of
20214     * the cube.
20215     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20216     * right as if the flip was a cube, the other content is show as the left
20217     * face of the cube.
20218     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20219     * flip was a cube, the other content is show as the bottom face of the cube.
20220     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20221     * the flip was a cube, the other content is show as the upper face of the
20222     * cube.
20223     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20224     * if the flip was a book, the other content is shown as the page below that.
20225     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20226     * as if the flip was a book, the other content is shown as the page below
20227     * that.
20228     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20229     * flip was a book, the other content is shown as the page below that.
20230     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20231     * flip was a book, the other content is shown as the page below that.
20232     *
20233     * @image html elm_flip.png
20234     * @image latex elm_flip.eps width=\textwidth
20235     */
20236    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20237    /**
20238     * @brief Set the interactive flip mode
20239     *
20240     * @param obj The flip object
20241     * @param mode The interactive flip mode to use
20242     *
20243     * This sets if the flip should be interactive (allow user to click and
20244     * drag a side of the flip to reveal the back page and cause it to flip).
20245     * By default a flip is not interactive. You may also need to set which
20246     * sides of the flip are "active" for flipping and how much space they use
20247     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20248     * and elm_flip_interacton_direction_hitsize_set()
20249     *
20250     * The four avilable mode of interaction are:
20251     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20252     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20253     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20254     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20255     *
20256     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20257     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20258     * happen, those can only be acheived with elm_flip_go();
20259     */
20260    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20261    /**
20262     * @brief Get the interactive flip mode
20263     *
20264     * @param obj The flip object
20265     * @return The interactive flip mode
20266     *
20267     * Returns the interactive flip mode set by elm_flip_interaction_set()
20268     */
20269    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20270    /**
20271     * @brief Set which directions of the flip respond to interactive flip
20272     *
20273     * @param obj The flip object
20274     * @param dir The direction to change
20275     * @param enabled If that direction is enabled or not
20276     *
20277     * By default all directions are disabled, so you may want to enable the
20278     * desired directions for flipping if you need interactive flipping. You must
20279     * call this function once for each direction that should be enabled.
20280     *
20281     * @see elm_flip_interaction_set()
20282     */
20283    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20284    /**
20285     * @brief Get the enabled state of that flip direction
20286     *
20287     * @param obj The flip object
20288     * @param dir The direction to check
20289     * @return If that direction is enabled or not
20290     *
20291     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20292     *
20293     * @see elm_flip_interaction_set()
20294     */
20295    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20296    /**
20297     * @brief Set the amount of the flip that is sensitive to interactive flip
20298     *
20299     * @param obj The flip object
20300     * @param dir The direction to modify
20301     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20302     *
20303     * Set the amount of the flip that is sensitive to interactive flip, with 0
20304     * representing no area in the flip and 1 representing the entire flip. There
20305     * is however a consideration to be made in that the area will never be
20306     * smaller than the finger size set(as set in your Elementary configuration).
20307     *
20308     * @see elm_flip_interaction_set()
20309     */
20310    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20311    /**
20312     * @brief Get the amount of the flip that is sensitive to interactive flip
20313     *
20314     * @param obj The flip object
20315     * @param dir The direction to check
20316     * @return The size set for that direction
20317     *
20318     * Returns the amount os sensitive area set by
20319     * elm_flip_interacton_direction_hitsize_set().
20320     */
20321    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20322    /**
20323     * @}
20324     */
20325
20326    /* scrolledentry */
20327    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20328    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20329    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20330    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20331    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20332    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20333    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20334    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20335    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20336    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20337    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20338    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20339    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20340    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20341    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20342    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20343    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20344    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20345    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20346    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20347    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20348    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20349    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20350    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20351    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20352    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20353    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20354    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20355    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20356    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20357    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20358    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20359    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20360    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20361    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20362    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);
20363    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20364    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20365    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);
20366    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20367    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);
20368    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20369    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20370    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20371    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20372    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20373    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20374    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20375    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20376    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);
20377    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);
20378    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);
20379    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);
20380    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);
20381    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);
20382    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20383    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20384    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20385    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20386    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20387    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20388    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20389
20390    /**
20391     * @defgroup Conformant Conformant
20392     * @ingroup Elementary
20393     *
20394     * @image html img/widget/conformant/preview-00.png
20395     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20396     *
20397     * @image html img/conformant.png
20398     * @image latex img/conformant.eps width=\textwidth
20399     *
20400     * The aim is to provide a widget that can be used in elementary apps to
20401     * account for space taken up by the indicator, virtual keypad & softkey
20402     * windows when running the illume2 module of E17.
20403     *
20404     * So conformant content will be sized and positioned considering the
20405     * space required for such stuff, and when they popup, as a keyboard
20406     * shows when an entry is selected, conformant content won't change.
20407     *
20408     * Available styles for it:
20409     * - @c "default"
20410     *
20411     * See how to use this widget in this example:
20412     * @ref conformant_example
20413     */
20414
20415    /**
20416     * @addtogroup Conformant
20417     * @{
20418     */
20419
20420    /**
20421     * Add a new conformant widget to the given parent Elementary
20422     * (container) object.
20423     *
20424     * @param parent The parent object.
20425     * @return A new conformant widget handle or @c NULL, on errors.
20426     *
20427     * This function inserts a new conformant widget on the canvas.
20428     *
20429     * @ingroup Conformant
20430     */
20431    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20432
20433    /**
20434     * Set the content of the conformant widget.
20435     *
20436     * @param obj The conformant object.
20437     * @param content The content to be displayed by the conformant.
20438     *
20439     * Content will be sized and positioned considering the space required
20440     * to display a virtual keyboard. So it won't fill all the conformant
20441     * size. This way is possible to be sure that content won't resize
20442     * or be re-positioned after the keyboard is displayed.
20443     *
20444     * Once the content object is set, a previously set one will be deleted.
20445     * If you want to keep that old content object, use the
20446     * elm_conformat_content_unset() function.
20447     *
20448     * @see elm_conformant_content_unset()
20449     * @see elm_conformant_content_get()
20450     *
20451     * @ingroup Conformant
20452     */
20453    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20454
20455    /**
20456     * Get the content of the conformant widget.
20457     *
20458     * @param obj The conformant object.
20459     * @return The content that is being used.
20460     *
20461     * Return the content object which is set for this widget.
20462     * It won't be unparent from conformant. For that, use
20463     * elm_conformant_content_unset().
20464     *
20465     * @see elm_conformant_content_set() for more details.
20466     * @see elm_conformant_content_unset()
20467     *
20468     * @ingroup Conformant
20469     */
20470    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20471
20472    /**
20473     * Unset the content of the conformant widget.
20474     *
20475     * @param obj The conformant object.
20476     * @return The content that was being used.
20477     *
20478     * Unparent and return the content object which was set for this widget.
20479     *
20480     * @see elm_conformant_content_set() for more details.
20481     *
20482     * @ingroup Conformant
20483     */
20484    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20485
20486    /**
20487     * Returns the Evas_Object that represents the content area.
20488     *
20489     * @param obj The conformant object.
20490     * @return The content area of the widget.
20491     *
20492     * @ingroup Conformant
20493     */
20494    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20495
20496    /**
20497     * @}
20498     */
20499
20500    /**
20501     * @defgroup Mapbuf Mapbuf
20502     * @ingroup Elementary
20503     *
20504     * @image html img/widget/mapbuf/preview-00.png
20505     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20506     *
20507     * This holds one content object and uses an Evas Map of transformation
20508     * points to be later used with this content. So the content will be
20509     * moved, resized, etc as a single image. So it will improve performance
20510     * when you have a complex interafce, with a lot of elements, and will
20511     * need to resize or move it frequently (the content object and its
20512     * children).
20513     *
20514     * See how to use this widget in this example:
20515     * @ref mapbuf_example
20516     */
20517
20518    /**
20519     * @addtogroup Mapbuf
20520     * @{
20521     */
20522
20523    /**
20524     * Add a new mapbuf widget to the given parent Elementary
20525     * (container) object.
20526     *
20527     * @param parent The parent object.
20528     * @return A new mapbuf widget handle or @c NULL, on errors.
20529     *
20530     * This function inserts a new mapbuf widget on the canvas.
20531     *
20532     * @ingroup Mapbuf
20533     */
20534    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20535
20536    /**
20537     * Set the content of the mapbuf.
20538     *
20539     * @param obj The mapbuf object.
20540     * @param content The content that will be filled in this mapbuf object.
20541     *
20542     * Once the content object is set, a previously set one will be deleted.
20543     * If you want to keep that old content object, use the
20544     * elm_mapbuf_content_unset() function.
20545     *
20546     * To enable map, elm_mapbuf_enabled_set() should be used.
20547     *
20548     * @ingroup Mapbuf
20549     */
20550    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20551
20552    /**
20553     * Get the content of the mapbuf.
20554     *
20555     * @param obj The mapbuf object.
20556     * @return The content that is being used.
20557     *
20558     * Return the content object which is set for this widget.
20559     *
20560     * @see elm_mapbuf_content_set() for details.
20561     *
20562     * @ingroup Mapbuf
20563     */
20564    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20565
20566    /**
20567     * Unset the content of the mapbuf.
20568     *
20569     * @param obj The mapbuf object.
20570     * @return The content that was being used.
20571     *
20572     * Unparent and return the content object which was set for this widget.
20573     *
20574     * @see elm_mapbuf_content_set() for details.
20575     *
20576     * @ingroup Mapbuf
20577     */
20578    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20579
20580    /**
20581     * Enable or disable the map.
20582     *
20583     * @param obj The mapbuf object.
20584     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20585     *
20586     * This enables the map that is set or disables it. On enable, the object
20587     * geometry will be saved, and the new geometry will change (position and
20588     * size) to reflect the map geometry set.
20589     *
20590     * Also, when enabled, alpha and smooth states will be used, so if the
20591     * content isn't solid, alpha should be enabled, for example, otherwise
20592     * a black retangle will fill the content.
20593     *
20594     * When disabled, the stored map will be freed and geometry prior to
20595     * enabling the map will be restored.
20596     *
20597     * It's disabled by default.
20598     *
20599     * @see elm_mapbuf_alpha_set()
20600     * @see elm_mapbuf_smooth_set()
20601     *
20602     * @ingroup Mapbuf
20603     */
20604    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20605
20606    /**
20607     * Get a value whether map is enabled or not.
20608     *
20609     * @param obj The mapbuf object.
20610     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20611     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20612     *
20613     * @see elm_mapbuf_enabled_set() for details.
20614     *
20615     * @ingroup Mapbuf
20616     */
20617    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20618
20619    /**
20620     * Enable or disable smooth map rendering.
20621     *
20622     * @param obj The mapbuf object.
20623     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20624     * to disable it.
20625     *
20626     * This sets smoothing for map rendering. If the object is a type that has
20627     * its own smoothing settings, then both the smooth settings for this object
20628     * and the map must be turned off.
20629     *
20630     * By default smooth maps are enabled.
20631     *
20632     * @ingroup Mapbuf
20633     */
20634    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20635
20636    /**
20637     * Get a value whether smooth map rendering is enabled or not.
20638     *
20639     * @param obj The mapbuf object.
20640     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20641     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20642     *
20643     * @see elm_mapbuf_smooth_set() for details.
20644     *
20645     * @ingroup Mapbuf
20646     */
20647    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20648
20649    /**
20650     * Set or unset alpha flag for map rendering.
20651     *
20652     * @param obj The mapbuf object.
20653     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20654     * to disable it.
20655     *
20656     * This sets alpha flag for map rendering. If the object is a type that has
20657     * its own alpha settings, then this will take precedence. Only image objects
20658     * have this currently. It stops alpha blending of the map area, and is
20659     * useful if you know the object and/or all sub-objects is 100% solid.
20660     *
20661     * Alpha is enabled by default.
20662     *
20663     * @ingroup Mapbuf
20664     */
20665    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20666
20667    /**
20668     * Get a value whether alpha blending is enabled or not.
20669     *
20670     * @param obj The mapbuf object.
20671     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20672     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20673     *
20674     * @see elm_mapbuf_alpha_set() for details.
20675     *
20676     * @ingroup Mapbuf
20677     */
20678    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20679
20680    /**
20681     * @}
20682     */
20683
20684    /**
20685     * @defgroup Flipselector Flip Selector
20686     *
20687     * @image html img/widget/flipselector/preview-00.png
20688     * @image latex img/widget/flipselector/preview-00.eps
20689     *
20690     * A flip selector is a widget to show a set of @b text items, one
20691     * at a time, with the same sheet switching style as the @ref Clock
20692     * "clock" widget, when one changes the current displaying sheet
20693     * (thus, the "flip" in the name).
20694     *
20695     * User clicks to flip sheets which are @b held for some time will
20696     * make the flip selector to flip continuosly and automatically for
20697     * the user. The interval between flips will keep growing in time,
20698     * so that it helps the user to reach an item which is distant from
20699     * the current selection.
20700     *
20701     * Smart callbacks one can register to:
20702     * - @c "selected" - when the widget's selected text item is changed
20703     * - @c "overflowed" - when the widget's current selection is changed
20704     *   from the first item in its list to the last
20705     * - @c "underflowed" - when the widget's current selection is changed
20706     *   from the last item in its list to the first
20707     *
20708     * Available styles for it:
20709     * - @c "default"
20710     *
20711     * Here is an example on its usage:
20712     * @li @ref flipselector_example
20713     */
20714
20715    /**
20716     * @addtogroup Flipselector
20717     * @{
20718     */
20719
20720    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
20721
20722    /**
20723     * Add a new flip selector widget to the given parent Elementary
20724     * (container) widget
20725     *
20726     * @param parent The parent object
20727     * @return a new flip selector widget handle or @c NULL, on errors
20728     *
20729     * This function inserts a new flip selector widget on the canvas.
20730     *
20731     * @ingroup Flipselector
20732     */
20733    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20734
20735    /**
20736     * Programmatically select the next item of a flip selector widget
20737     *
20738     * @param obj The flipselector object
20739     *
20740     * @note The selection will be animated. Also, if it reaches the
20741     * end of its list of member items, it will continue with the first
20742     * one onwards.
20743     *
20744     * @ingroup Flipselector
20745     */
20746    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20747
20748    /**
20749     * Programmatically select the previous item of a flip selector
20750     * widget
20751     *
20752     * @param obj The flipselector object
20753     *
20754     * @note The selection will be animated.  Also, if it reaches the
20755     * beginning of its list of member items, it will continue with the
20756     * last one backwards.
20757     *
20758     * @ingroup Flipselector
20759     */
20760    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20761
20762    /**
20763     * Append a (text) item to a flip selector widget
20764     *
20765     * @param obj The flipselector object
20766     * @param label The (text) label of the new item
20767     * @param func Convenience callback function to take place when
20768     * item is selected
20769     * @param data Data passed to @p func, above
20770     * @return A handle to the item added or @c NULL, on errors
20771     *
20772     * The widget's list of labels to show will be appended with the
20773     * given value. If the user wishes so, a callback function pointer
20774     * can be passed, which will get called when this same item is
20775     * selected.
20776     *
20777     * @note The current selection @b won't be modified by appending an
20778     * element to the list.
20779     *
20780     * @note The maximum length of the text label is going to be
20781     * determined <b>by the widget's theme</b>. Strings larger than
20782     * that value are going to be @b truncated.
20783     *
20784     * @ingroup Flipselector
20785     */
20786    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20787
20788    /**
20789     * Prepend a (text) item to a flip selector widget
20790     *
20791     * @param obj The flipselector object
20792     * @param label The (text) label of the new item
20793     * @param func Convenience callback function to take place when
20794     * item is selected
20795     * @param data Data passed to @p func, above
20796     * @return A handle to the item added or @c NULL, on errors
20797     *
20798     * The widget's list of labels to show will be prepended with the
20799     * given value. If the user wishes so, a callback function pointer
20800     * can be passed, which will get called when this same item is
20801     * selected.
20802     *
20803     * @note The current selection @b won't be modified by prepending
20804     * an element to the list.
20805     *
20806     * @note The maximum length of the text label is going to be
20807     * determined <b>by the widget's theme</b>. Strings larger than
20808     * that value are going to be @b truncated.
20809     *
20810     * @ingroup Flipselector
20811     */
20812    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20813
20814    /**
20815     * Get the internal list of items in a given flip selector widget.
20816     *
20817     * @param obj The flipselector object
20818     * @return The list of items (#Elm_Flipselector_Item as data) or
20819     * @c NULL on errors.
20820     *
20821     * This list is @b not to be modified in any way and must not be
20822     * freed. Use the list members with functions like
20823     * elm_flipselector_item_label_set(),
20824     * elm_flipselector_item_label_get(),
20825     * elm_flipselector_item_del(),
20826     * elm_flipselector_item_selected_get(),
20827     * elm_flipselector_item_selected_set().
20828     *
20829     * @warning This list is only valid until @p obj object's internal
20830     * items list is changed. It should be fetched again with another
20831     * call to this function when changes happen.
20832     *
20833     * @ingroup Flipselector
20834     */
20835    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20836
20837    /**
20838     * Get the first item in the given flip selector widget's list of
20839     * items.
20840     *
20841     * @param obj The flipselector object
20842     * @return The first item or @c NULL, if it has no items (and on
20843     * errors)
20844     *
20845     * @see elm_flipselector_item_append()
20846     * @see elm_flipselector_last_item_get()
20847     *
20848     * @ingroup Flipselector
20849     */
20850    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20851
20852    /**
20853     * Get the last item in the given flip selector widget's list of
20854     * items.
20855     *
20856     * @param obj The flipselector object
20857     * @return The last item or @c NULL, if it has no items (and on
20858     * errors)
20859     *
20860     * @see elm_flipselector_item_prepend()
20861     * @see elm_flipselector_first_item_get()
20862     *
20863     * @ingroup Flipselector
20864     */
20865    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20866
20867    /**
20868     * Get the currently selected item in a flip selector widget.
20869     *
20870     * @param obj The flipselector object
20871     * @return The selected item or @c NULL, if the widget has no items
20872     * (and on erros)
20873     *
20874     * @ingroup Flipselector
20875     */
20876    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20877
20878    /**
20879     * Set whether a given flip selector widget's item should be the
20880     * currently selected one.
20881     *
20882     * @param item The flip selector item
20883     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
20884     *
20885     * This sets whether @p item is or not the selected (thus, under
20886     * display) one. If @p item is different than one under display,
20887     * the latter will be unselected. If the @p item is set to be
20888     * unselected, on the other hand, the @b first item in the widget's
20889     * internal members list will be the new selected one.
20890     *
20891     * @see elm_flipselector_item_selected_get()
20892     *
20893     * @ingroup Flipselector
20894     */
20895    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20896
20897    /**
20898     * Get whether a given flip selector widget's item is the currently
20899     * selected one.
20900     *
20901     * @param item The flip selector item
20902     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20903     * (or on errors).
20904     *
20905     * @see elm_flipselector_item_selected_set()
20906     *
20907     * @ingroup Flipselector
20908     */
20909    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20910
20911    /**
20912     * Delete a given item from a flip selector widget.
20913     *
20914     * @param item The item to delete
20915     *
20916     * @ingroup Flipselector
20917     */
20918    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20919
20920    /**
20921     * Get the label of a given flip selector widget's item.
20922     *
20923     * @param item The item to get label from
20924     * @return The text label of @p item or @c NULL, on errors
20925     *
20926     * @see elm_flipselector_item_label_set()
20927     *
20928     * @ingroup Flipselector
20929     */
20930    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20931
20932    /**
20933     * Set the label of a given flip selector widget's item.
20934     *
20935     * @param item The item to set label on
20936     * @param label The text label string, in UTF-8 encoding
20937     *
20938     * @see elm_flipselector_item_label_get()
20939     *
20940     * @ingroup Flipselector
20941     */
20942    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
20943
20944    /**
20945     * Gets the item before @p item in a flip selector widget's
20946     * internal list of items.
20947     *
20948     * @param item The item to fetch previous from
20949     * @return The item before the @p item, in its parent's list. If
20950     *         there is no previous item for @p item or there's an
20951     *         error, @c NULL is returned.
20952     *
20953     * @see elm_flipselector_item_next_get()
20954     *
20955     * @ingroup Flipselector
20956     */
20957    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20958
20959    /**
20960     * Gets the item after @p item in a flip selector widget's
20961     * internal list of items.
20962     *
20963     * @param item The item to fetch next from
20964     * @return The item after the @p item, in its parent's list. If
20965     *         there is no next item for @p item or there's an
20966     *         error, @c NULL is returned.
20967     *
20968     * @see elm_flipselector_item_next_get()
20969     *
20970     * @ingroup Flipselector
20971     */
20972    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
20973
20974    /**
20975     * Set the interval on time updates for an user mouse button hold
20976     * on a flip selector widget.
20977     *
20978     * @param obj The flip selector object
20979     * @param interval The (first) interval value in seconds
20980     *
20981     * This interval value is @b decreased while the user holds the
20982     * mouse pointer either flipping up or flipping doww a given flip
20983     * selector.
20984     *
20985     * This helps the user to get to a given item distant from the
20986     * current one easier/faster, as it will start to flip quicker and
20987     * quicker on mouse button holds.
20988     *
20989     * The calculation for the next flip interval value, starting from
20990     * the one set with this call, is the previous interval divided by
20991     * 1.05, so it decreases a little bit.
20992     *
20993     * The default starting interval value for automatic flips is
20994     * @b 0.85 seconds.
20995     *
20996     * @see elm_flipselector_interval_get()
20997     *
20998     * @ingroup Flipselector
20999     */
21000    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21001
21002    /**
21003     * Get the interval on time updates for an user mouse button hold
21004     * on a flip selector widget.
21005     *
21006     * @param obj The flip selector object
21007     * @return The (first) interval value, in seconds, set on it
21008     *
21009     * @see elm_flipselector_interval_set() for more details
21010     *
21011     * @ingroup Flipselector
21012     */
21013    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21014
21015    /**
21016     * @}
21017     */
21018
21019    /**
21020     * @addtogroup Animator Animator
21021     * @ingroup Elementary
21022     *
21023     * @brief Functions to ease creation of animations.
21024     *
21025     * elm_animator is designed to provide an easy way to create animations.
21026     * Creating an animation with elm_animator is as simple as setting a
21027     * duration, an operating callback and telling it to run the animation.
21028     * However that is not the full extent of elm_animator's ability, animations
21029     * can be paused and resumed, reversed and the animation need not be linear.
21030     *
21031     * To run an animation you must specify at least a duration and operation
21032     * callback, not setting any other properties will create a linear animation
21033     * that runs once and is not reversed.
21034     *
21035     * @ref elm_animator_example_page_01 "This" example should make all of that
21036     * very clear.
21037     *
21038     * @warning elm_animator is @b not a widget.
21039     * @{
21040     */
21041    /**
21042     * @brief Type of curve desired for animation.
21043     *
21044     * The speed in which an animation happens doesn't have to be linear, some
21045     * animations will look better if they're accelerating or decelerating, so
21046     * elm_animator provides four options in this regard:
21047     *
21048     * @image html elm_animator_curve_style.png
21049     * @image latex elm_animator_curve_style.eps width=\textwidth
21050     * As can be seen in the image the speed of the animation will be:
21051     * @li ELM_ANIMATOR_CURVE_LINEAR constant
21052     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
21053     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
21054     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
21055     */
21056    typedef enum
21057      {
21058         ELM_ANIMATOR_CURVE_LINEAR,
21059         ELM_ANIMATOR_CURVE_IN_OUT,
21060         ELM_ANIMATOR_CURVE_IN,
21061         ELM_ANIMATOR_CURVE_OUT
21062      } Elm_Animator_Curve_Style;
21063    typedef struct _Elm_Animator Elm_Animator;
21064   /**
21065    * Called back per loop of an elementary animators cycle
21066    * @param data user-data given to elm_animator_operation_callback_set()
21067    * @param animator the animator being run
21068    * @param double the position in the animation
21069    */
21070    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
21071   /**
21072    * Called back when an elementary animator finishes
21073    * @param data user-data given to elm_animator_completion_callback_set()
21074    */
21075    typedef void (*Elm_Animator_Completion_Cb) (void *data);
21076
21077    /**
21078     * @brief Create a new animator.
21079     *
21080     * @param[in] parent Parent object
21081     *
21082     * The @a parent argument can be set to NULL for no parent. If a parent is set
21083     * there is no need to call elm_animator_del(), when the parent is deleted it
21084     * will delete the animator.
21085     * @deprecated Use @ref Transit instead.
21086     */
21087    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
21088    /**
21089     * Deletes the animator freeing any resources it used. If the animator was
21090     * created with a NULL parent this must be called, otherwise it will be
21091     * automatically called when the parent is deleted.
21092     *
21093     * @param[in] animator Animator object
21094     * @deprecated Use @ref Transit instead.
21095     */
21096    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21097    /**
21098     * Set the duration of the animation.
21099     *
21100     * @param[in] animator Animator object
21101     * @param[in] duration Duration in second
21102     * @deprecated Use @ref Transit instead.
21103     */
21104    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
21105    /**
21106     * @brief Set the callback function for animator operation.
21107     *
21108     * @param[in] animator Animator object
21109     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
21110     * @param[in] data Callback function user argument
21111     *
21112     * The @p func callback will be called with a frame value in range [0, 1] which
21113     * indicates how far along the animation should be. It is the job of @p func to
21114     * actually change the state of any object(or objects) that are being animated.
21115     * @deprecated Use @ref Transit instead.
21116     */
21117    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
21118    /**
21119     * Set the callback function for the when the animation ends.
21120     *
21121     * @param[in]  animator Animator object
21122     * @param[in]  func   Callback function pointe
21123     * @param[in]  data Callback function user argument
21124     *
21125     * @warning @a func will not be executed if elm_animator_stop() is called.
21126     * @deprecated Use @ref Transit instead.
21127     */
21128    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
21129    /**
21130     * @brief Stop animator.
21131     *
21132     * @param[in] animator Animator object
21133     *
21134     * If called before elm_animator_animate() it does nothing. If there is an
21135     * animation in progress the animation will be stopped(the operation callback
21136     * will not be executed again) and it can't be restarted using
21137     * elm_animator_resume().
21138     * @deprecated Use @ref Transit instead.
21139     */
21140    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21141    /**
21142     * Set the animator repeat count.
21143     *
21144     * @param[in]  animator Animator object
21145     * @param[in]  repeat_cnt Repeat count
21146     * @deprecated Use @ref Transit instead.
21147     */
21148    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
21149    /**
21150     * @brief Start animation.
21151     *
21152     * @param[in] animator Animator object
21153     *
21154     * This function starts the animation if the nescessary properties(duration
21155     * and operation callback) have been set. Once started the animation will
21156     * run until complete or elm_animator_stop() is called.
21157     * @deprecated Use @ref Transit instead.
21158     */
21159    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21160    /**
21161     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21162     *
21163     * @param[in] animator Animator object
21164     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21165     * @deprecated Use @ref Transit instead.
21166     */
21167    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
21168    /**
21169     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21170     *
21171     * @param[in] animator Animator object
21172     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21173     * @deprecated Use @ref Transit instead.
21174     */
21175    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21176    /**
21177     * @brief Sets wether the animation should be automatically reversed.
21178     *
21179     * @param[in] animator Animator object
21180     * @param[in] reverse Reverse or not
21181     *
21182     * This controls wether the animation will be run on reverse imediately after
21183     * running forward. When this is set together with repetition the animation
21184     * will run in reverse once for each time it ran forward.@n
21185     * Runnin an animation in reverse is accomplished by calling the operation
21186     * callback with a frame value starting at 1 and diminshing until 0.
21187     * @deprecated Use @ref Transit instead.
21188     */
21189    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
21190    /**
21191     * Gets wether the animation will automatically reversed
21192     *
21193     * @param[in] animator Animator object
21194     * @deprecated Use @ref Transit instead.
21195     */
21196    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21197    /**
21198     * Gets the status for the animator operation. The status of the animator @b
21199     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
21200     * only informs if the animation was started and has not ended(either normally
21201     * or through elm_animator_stop()).
21202     *
21203     * @param[in] animator Animator object
21204     * @deprecated Use @ref Transit instead.
21205     */
21206    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21207    /**
21208     * Gets how many times the animation will be repeated
21209     *
21210     * @param[in] animator Animator object
21211     * @deprecated Use @ref Transit instead.
21212     */
21213    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21214    /**
21215     * Pause the animator.
21216     *
21217     * @param[in]  animator Animator object
21218     *
21219     * This causes the animation to be temporarily stopped(the operation callback
21220     * will not be called). If the animation is not yet running this is a no-op.
21221     * Once an animation has been paused with this function it can be resumed
21222     * using elm_animator_resume().
21223     * @deprecated Use @ref Transit instead.
21224     */
21225    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21226    /**
21227     * @brief Resumes the animator.
21228     *
21229     * @param[in]  animator Animator object
21230     *
21231     * Resumes an animation that was paused using elm_animator_pause(), after
21232     * calling this function calls to the operation callback will happen
21233     * normally. If an animation is stopped by means of elm_animator_stop it
21234     * @b can't be restarted with this function.@n
21235     *
21236     * @warning When an animation is resumed it doesn't start from where it was paused, it
21237     * will go to where it would have been if it had not been paused. If an
21238     * animation with a duration of 3 seconds is paused after 1 second for 1 second
21239     * it will resume as if it had ben animating for 2 seconds, the operating
21240     * callback will be called with a frame value of aproximately 2/3.
21241     * @deprecated Use @ref Transit instead.
21242     */
21243    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21244    /**
21245     * @}
21246     */
21247
21248    /**
21249     * @defgroup Calendar Calendar
21250     * @ingroup Elementary
21251     *
21252     * @image html img/widget/calendar/preview-00.png
21253     * @image latex img/widget/calendar/preview-00.eps
21254     *
21255     * A calendar is a widget that displays a regular calendar, one
21256     * month at a time, to the user, and can allows the user to select a date.
21257     *
21258     * It has support to adding check marks (holidays and checks are supported
21259     * by default theme).
21260     *
21261     * Weekday names and the function used to format month and year to
21262     * be displayed can be set, giving more flexibility to this widget.
21263     *
21264     * Smart callbacks one can register to:
21265     * - "changed" - emitted when the user selects a day or changes the
21266     *   displayed month, what actually changes the selected day as well.
21267     *
21268     * Available styles for it:
21269     * - @c "default"
21270     *
21271     * List of examples:
21272     * @li @ref calendar_example_01
21273     * @li @ref calendar_example_02
21274     * @li @ref calendar_example_03
21275     * @li @ref calendar_example_04
21276     * @li @ref calendar_example_05
21277     * @li @ref calendar_example_06
21278     */
21279
21280    /**
21281     * @addtogroup Calendar
21282     * @{
21283     */
21284
21285    /**
21286     * @enum _Elm_Calendar_Mark_Repeat
21287     * @typedef Elm_Calendar_Mark_Repeat
21288     *
21289     * Event periodicity, used to define if a mark should be repeated
21290     * @b beyond event's day. It's set when a mark is added.
21291     *
21292     * So, for a mark added to 13th May with periodicity set to WEEKLY,
21293     * there will be marks every week after this date. Marks will be displayed
21294     * at 13th, 20th, 27th, 3rd June ...
21295     *
21296     * Values don't work as bitmask, only one can be choosen.
21297     *
21298     * @see elm_calendar_mark_add()
21299     *
21300     * @ingroup Calendar
21301     */
21302    typedef enum _Elm_Calendar_Mark_Repeat
21303      {
21304         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21305         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21306         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21307         ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
21308         ELM_CALENDAR_ANNUALLY /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
21309      } Elm_Calendar_Mark_Repeat;
21310
21311    typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a calendar mark. Created with elm_calendar_mark_add() and deleted with elm_calendar_mark_del(). */
21312
21313    /**
21314     * Add a new calendar widget to the given parent Elementary
21315     * (container) object.
21316     *
21317     * @param parent The parent object.
21318     * @return a new calendar widget handle or @c NULL, on errors.
21319     *
21320     * This function inserts a new calendar widget on the canvas.
21321     *
21322     * @ref calendar_example_01
21323     *
21324     * @ingroup Calendar
21325     */
21326    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21327
21328    /**
21329     * Get weekdays names displayed by the calendar.
21330     *
21331     * @param obj The calendar object.
21332     * @return Array of seven strings to be used as weekday names.
21333     *
21334     * By default, weekdays abbreviations get from system are displayed:
21335     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21336     * The first string is related to Sunday, the second to Monday...
21337     *
21338     * @see elm_calendar_weekdays_name_set()
21339     *
21340     * @ref calendar_example_05
21341     *
21342     * @ingroup Calendar
21343     */
21344    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21345
21346    /**
21347     * Set weekdays names to be displayed by the calendar.
21348     *
21349     * @param obj The calendar object.
21350     * @param weekdays Array of seven strings to be used as weekday names.
21351     * @warning It must have 7 elements, or it will access invalid memory.
21352     * @warning The strings must be NULL terminated ('@\0').
21353     *
21354     * By default, weekdays abbreviations get from system are displayed:
21355     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21356     *
21357     * The first string should be related to Sunday, the second to Monday...
21358     *
21359     * The usage should be like this:
21360     * @code
21361     *   const char *weekdays[] =
21362     *   {
21363     *      "Sunday", "Monday", "Tuesday", "Wednesday",
21364     *      "Thursday", "Friday", "Saturday"
21365     *   };
21366     *   elm_calendar_weekdays_names_set(calendar, weekdays);
21367     * @endcode
21368     *
21369     * @see elm_calendar_weekdays_name_get()
21370     *
21371     * @ref calendar_example_02
21372     *
21373     * @ingroup Calendar
21374     */
21375    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21376
21377    /**
21378     * Set the minimum and maximum values for the year
21379     *
21380     * @param obj The calendar object
21381     * @param min The minimum year, greater than 1901;
21382     * @param max The maximum year;
21383     *
21384     * Maximum must be greater than minimum, except if you don't wan't to set
21385     * maximum year.
21386     * Default values are 1902 and -1.
21387     *
21388     * If the maximum year is a negative value, it will be limited depending
21389     * on the platform architecture (year 2037 for 32 bits);
21390     *
21391     * @see elm_calendar_min_max_year_get()
21392     *
21393     * @ref calendar_example_03
21394     *
21395     * @ingroup Calendar
21396     */
21397    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21398
21399    /**
21400     * Get the minimum and maximum values for the year
21401     *
21402     * @param obj The calendar object.
21403     * @param min The minimum year.
21404     * @param max The maximum year.
21405     *
21406     * Default values are 1902 and -1.
21407     *
21408     * @see elm_calendar_min_max_year_get() for more details.
21409     *
21410     * @ref calendar_example_05
21411     *
21412     * @ingroup Calendar
21413     */
21414    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21415
21416    /**
21417     * Enable or disable day selection
21418     *
21419     * @param obj The calendar object.
21420     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21421     * disable it.
21422     *
21423     * Enabled by default. If disabled, the user still can select months,
21424     * but not days. Selected days are highlighted on calendar.
21425     * It should be used if you won't need such selection for the widget usage.
21426     *
21427     * When a day is selected, or month is changed, smart callbacks for
21428     * signal "changed" will be called.
21429     *
21430     * @see elm_calendar_day_selection_enable_get()
21431     *
21432     * @ref calendar_example_04
21433     *
21434     * @ingroup Calendar
21435     */
21436    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21437
21438    /**
21439     * Get a value whether day selection is enabled or not.
21440     *
21441     * @see elm_calendar_day_selection_enable_set() for details.
21442     *
21443     * @param obj The calendar object.
21444     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21445     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21446     *
21447     * @ref calendar_example_05
21448     *
21449     * @ingroup Calendar
21450     */
21451    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21452
21453
21454    /**
21455     * Set selected date to be highlighted on calendar.
21456     *
21457     * @param obj The calendar object.
21458     * @param selected_time A @b tm struct to represent the selected date.
21459     *
21460     * Set the selected date, changing the displayed month if needed.
21461     * Selected date changes when the user goes to next/previous month or
21462     * select a day pressing over it on calendar.
21463     *
21464     * @see elm_calendar_selected_time_get()
21465     *
21466     * @ref calendar_example_04
21467     *
21468     * @ingroup Calendar
21469     */
21470    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21471
21472    /**
21473     * Get selected date.
21474     *
21475     * @param obj The calendar object
21476     * @param selected_time A @b tm struct to point to selected date
21477     * @return EINA_FALSE means an error ocurred and returned time shouldn't
21478     * be considered.
21479     *
21480     * Get date selected by the user or set by function
21481     * elm_calendar_selected_time_set().
21482     * Selected date changes when the user goes to next/previous month or
21483     * select a day pressing over it on calendar.
21484     *
21485     * @see elm_calendar_selected_time_get()
21486     *
21487     * @ref calendar_example_05
21488     *
21489     * @ingroup Calendar
21490     */
21491    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21492
21493    /**
21494     * Set a function to format the string that will be used to display
21495     * month and year;
21496     *
21497     * @param obj The calendar object
21498     * @param format_function Function to set the month-year string given
21499     * the selected date
21500     *
21501     * By default it uses strftime with "%B %Y" format string.
21502     * It should allocate the memory that will be used by the string,
21503     * that will be freed by the widget after usage.
21504     * A pointer to the string and a pointer to the time struct will be provided.
21505     *
21506     * Example:
21507     * @code
21508     * static char *
21509     * _format_month_year(struct tm *selected_time)
21510     * {
21511     *    char buf[32];
21512     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21513     *    return strdup(buf);
21514     * }
21515     *
21516     * elm_calendar_format_function_set(calendar, _format_month_year);
21517     * @endcode
21518     *
21519     * @ref calendar_example_02
21520     *
21521     * @ingroup Calendar
21522     */
21523    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21524
21525    /**
21526     * Add a new mark to the calendar
21527     *
21528     * @param obj The calendar object
21529     * @param mark_type A string used to define the type of mark. It will be
21530     * emitted to the theme, that should display a related modification on these
21531     * days representation.
21532     * @param mark_time A time struct to represent the date of inclusion of the
21533     * mark. For marks that repeats it will just be displayed after the inclusion
21534     * date in the calendar.
21535     * @param repeat Repeat the event following this periodicity. Can be a unique
21536     * mark (that don't repeat), daily, weekly, monthly or annually.
21537     * @return The created mark or @p NULL upon failure.
21538     *
21539     * Add a mark that will be drawn in the calendar respecting the insertion
21540     * time and periodicity. It will emit the type as signal to the widget theme.
21541     * Default theme supports "holiday" and "checked", but it can be extended.
21542     *
21543     * It won't immediately update the calendar, drawing the marks.
21544     * For this, call elm_calendar_marks_draw(). However, when user selects
21545     * next or previous month calendar forces marks drawn.
21546     *
21547     * Marks created with this method can be deleted with
21548     * elm_calendar_mark_del().
21549     *
21550     * Example
21551     * @code
21552     * struct tm selected_time;
21553     * time_t current_time;
21554     *
21555     * current_time = time(NULL) + 5 * 84600;
21556     * localtime_r(&current_time, &selected_time);
21557     * elm_calendar_mark_add(cal, "holiday", selected_time,
21558     *     ELM_CALENDAR_ANNUALLY);
21559     *
21560     * current_time = time(NULL) + 1 * 84600;
21561     * localtime_r(&current_time, &selected_time);
21562     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21563     *
21564     * elm_calendar_marks_draw(cal);
21565     * @endcode
21566     *
21567     * @see elm_calendar_marks_draw()
21568     * @see elm_calendar_mark_del()
21569     *
21570     * @ref calendar_example_06
21571     *
21572     * @ingroup Calendar
21573     */
21574    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);
21575
21576    /**
21577     * Delete mark from the calendar.
21578     *
21579     * @param mark The mark to be deleted.
21580     *
21581     * If deleting all calendar marks is required, elm_calendar_marks_clear()
21582     * should be used instead of getting marks list and deleting each one.
21583     *
21584     * @see elm_calendar_mark_add()
21585     *
21586     * @ref calendar_example_06
21587     *
21588     * @ingroup Calendar
21589     */
21590    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21591
21592    /**
21593     * Remove all calendar's marks
21594     *
21595     * @param obj The calendar object.
21596     *
21597     * @see elm_calendar_mark_add()
21598     * @see elm_calendar_mark_del()
21599     *
21600     * @ingroup Calendar
21601     */
21602    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21603
21604
21605    /**
21606     * Get a list of all the calendar marks.
21607     *
21608     * @param obj The calendar object.
21609     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21610     *
21611     * @see elm_calendar_mark_add()
21612     * @see elm_calendar_mark_del()
21613     * @see elm_calendar_marks_clear()
21614     *
21615     * @ingroup Calendar
21616     */
21617    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21618
21619    /**
21620     * Draw calendar marks.
21621     *
21622     * @param obj The calendar object.
21623     *
21624     * Should be used after adding, removing or clearing marks.
21625     * It will go through the entire marks list updating the calendar.
21626     * If lots of marks will be added, add all the marks and then call
21627     * this function.
21628     *
21629     * When the month is changed, i.e. user selects next or previous month,
21630     * marks will be drawed.
21631     *
21632     * @see elm_calendar_mark_add()
21633     * @see elm_calendar_mark_del()
21634     * @see elm_calendar_marks_clear()
21635     *
21636     * @ref calendar_example_06
21637     *
21638     * @ingroup Calendar
21639     */
21640    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21641
21642    /**
21643     * Set a day text color to the same that represents Saturdays.
21644     *
21645     * @param obj The calendar object.
21646     * @param pos The text position. Position is the cell counter, from left
21647     * to right, up to down. It starts on 0 and ends on 41.
21648     *
21649     * @deprecated use elm_calendar_mark_add() instead like:
21650     *
21651     * @code
21652     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21653     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21654     * @endcode
21655     *
21656     * @see elm_calendar_mark_add()
21657     *
21658     * @ingroup Calendar
21659     */
21660    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21661
21662    /**
21663     * Set a day text color to the same that represents Sundays.
21664     *
21665     * @param obj The calendar object.
21666     * @param pos The text position. Position is the cell counter, from left
21667     * to right, up to down. It starts on 0 and ends on 41.
21668
21669     * @deprecated use elm_calendar_mark_add() instead like:
21670     *
21671     * @code
21672     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21673     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21674     * @endcode
21675     *
21676     * @see elm_calendar_mark_add()
21677     *
21678     * @ingroup Calendar
21679     */
21680    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21681
21682    /**
21683     * Set a day text color to the same that represents Weekdays.
21684     *
21685     * @param obj The calendar object
21686     * @param pos The text position. Position is the cell counter, from left
21687     * to right, up to down. It starts on 0 and ends on 41.
21688     *
21689     * @deprecated use elm_calendar_mark_add() instead like:
21690     *
21691     * @code
21692     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21693     *
21694     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21695     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21696     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21697     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21698     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21699     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21700     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21701     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21702     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21703     * @endcode
21704     *
21705     * @see elm_calendar_mark_add()
21706     *
21707     * @ingroup Calendar
21708     */
21709    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21710
21711    /**
21712     * Set the interval on time updates for an user mouse button hold
21713     * on calendar widgets' month selection.
21714     *
21715     * @param obj The calendar object
21716     * @param interval The (first) interval value in seconds
21717     *
21718     * This interval value is @b decreased while the user holds the
21719     * mouse pointer either selecting next or previous month.
21720     *
21721     * This helps the user to get to a given month distant from the
21722     * current one easier/faster, as it will start to change quicker and
21723     * quicker on mouse button holds.
21724     *
21725     * The calculation for the next change interval value, starting from
21726     * the one set with this call, is the previous interval divided by
21727     * 1.05, so it decreases a little bit.
21728     *
21729     * The default starting interval value for automatic changes is
21730     * @b 0.85 seconds.
21731     *
21732     * @see elm_calendar_interval_get()
21733     *
21734     * @ingroup Calendar
21735     */
21736    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21737
21738    /**
21739     * Get the interval on time updates for an user mouse button hold
21740     * on calendar widgets' month selection.
21741     *
21742     * @param obj The calendar object
21743     * @return The (first) interval value, in seconds, set on it
21744     *
21745     * @see elm_calendar_interval_set() for more details
21746     *
21747     * @ingroup Calendar
21748     */
21749    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21750
21751    /**
21752     * @}
21753     */
21754
21755    /**
21756     * @defgroup Diskselector Diskselector
21757     * @ingroup Elementary
21758     *
21759     * @image html img/widget/diskselector/preview-00.png
21760     * @image latex img/widget/diskselector/preview-00.eps
21761     *
21762     * A diskselector is a kind of list widget. It scrolls horizontally,
21763     * and can contain label and icon objects. Three items are displayed
21764     * with the selected one in the middle.
21765     *
21766     * It can act like a circular list with round mode and labels can be
21767     * reduced for a defined length for side items.
21768     *
21769     * Smart callbacks one can listen to:
21770     * - "selected" - when item is selected, i.e. scroller stops.
21771     *
21772     * Available styles for it:
21773     * - @c "default"
21774     *
21775     * List of examples:
21776     * @li @ref diskselector_example_01
21777     * @li @ref diskselector_example_02
21778     */
21779
21780    /**
21781     * @addtogroup Diskselector
21782     * @{
21783     */
21784
21785    typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item; /**< Item handle for a diskselector item. Created with elm_diskselector_item_append() and deleted with elm_diskselector_item_del(). */
21786
21787    /**
21788     * Add a new diskselector widget to the given parent Elementary
21789     * (container) object.
21790     *
21791     * @param parent The parent object.
21792     * @return a new diskselector widget handle or @c NULL, on errors.
21793     *
21794     * This function inserts a new diskselector widget on the canvas.
21795     *
21796     * @ingroup Diskselector
21797     */
21798    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21799
21800    /**
21801     * Enable or disable round mode.
21802     *
21803     * @param obj The diskselector object.
21804     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21805     * disable it.
21806     *
21807     * Disabled by default. If round mode is enabled the items list will
21808     * work like a circle list, so when the user reaches the last item,
21809     * the first one will popup.
21810     *
21811     * @see elm_diskselector_round_get()
21812     *
21813     * @ingroup Diskselector
21814     */
21815    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21816
21817    /**
21818     * Get a value whether round mode is enabled or not.
21819     *
21820     * @see elm_diskselector_round_set() for details.
21821     *
21822     * @param obj The diskselector object.
21823     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21824     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21825     *
21826     * @ingroup Diskselector
21827     */
21828    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21829
21830    /**
21831     * Get the side labels max length.
21832     *
21833     * @deprecated use elm_diskselector_side_label_length_get() instead:
21834     *
21835     * @param obj The diskselector object.
21836     * @return The max length defined for side labels, or 0 if not a valid
21837     * diskselector.
21838     *
21839     * @ingroup Diskselector
21840     */
21841    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21842
21843    /**
21844     * Set the side labels max length.
21845     *
21846     * @deprecated use elm_diskselector_side_label_length_set() instead:
21847     *
21848     * @param obj The diskselector object.
21849     * @param len The max length defined for side labels.
21850     *
21851     * @ingroup Diskselector
21852     */
21853    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21854
21855    /**
21856     * Get the side labels max length.
21857     *
21858     * @see elm_diskselector_side_label_length_set() for details.
21859     *
21860     * @param obj The diskselector object.
21861     * @return The max length defined for side labels, or 0 if not a valid
21862     * diskselector.
21863     *
21864     * @ingroup Diskselector
21865     */
21866    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21867
21868    /**
21869     * Set the side labels max length.
21870     *
21871     * @param obj The diskselector object.
21872     * @param len The max length defined for side labels.
21873     *
21874     * Length is the number of characters of items' label that will be
21875     * visible when it's set on side positions. It will just crop
21876     * the string after defined size. E.g.:
21877     *
21878     * An item with label "January" would be displayed on side position as
21879     * "Jan" if max length is set to 3, or "Janu", if this property
21880     * is set to 4.
21881     *
21882     * When it's selected, the entire label will be displayed, except for
21883     * width restrictions. In this case label will be cropped and "..."
21884     * will be concatenated.
21885     *
21886     * Default side label max length is 3.
21887     *
21888     * This property will be applyed over all items, included before or
21889     * later this function call.
21890     *
21891     * @ingroup Diskselector
21892     */
21893    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21894
21895    /**
21896     * Set the number of items to be displayed.
21897     *
21898     * @param obj The diskselector object.
21899     * @param num The number of items the diskselector will display.
21900     *
21901     * Default value is 3, and also it's the minimun. If @p num is less
21902     * than 3, it will be set to 3.
21903     *
21904     * Also, it can be set on theme, using data item @c display_item_num
21905     * on group "elm/diskselector/item/X", where X is style set.
21906     * E.g.:
21907     *
21908     * group { name: "elm/diskselector/item/X";
21909     * data {
21910     *     item: "display_item_num" "5";
21911     *     }
21912     *
21913     * @ingroup Diskselector
21914     */
21915    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
21916
21917    /**
21918     * Set bouncing behaviour when the scrolled content reaches an edge.
21919     *
21920     * Tell the internal scroller object whether it should bounce or not
21921     * when it reaches the respective edges for each axis.
21922     *
21923     * @param obj The diskselector object.
21924     * @param h_bounce Whether to bounce or not in the horizontal axis.
21925     * @param v_bounce Whether to bounce or not in the vertical axis.
21926     *
21927     * @see elm_scroller_bounce_set()
21928     *
21929     * @ingroup Diskselector
21930     */
21931    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21932
21933    /**
21934     * Get the bouncing behaviour of the internal scroller.
21935     *
21936     * Get whether the internal scroller should bounce when the edge of each
21937     * axis is reached scrolling.
21938     *
21939     * @param obj The diskselector object.
21940     * @param h_bounce Pointer where to store the bounce state of the horizontal
21941     * axis.
21942     * @param v_bounce Pointer where to store the bounce state of the vertical
21943     * axis.
21944     *
21945     * @see elm_scroller_bounce_get()
21946     * @see elm_diskselector_bounce_set()
21947     *
21948     * @ingroup Diskselector
21949     */
21950    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21951
21952    /**
21953     * Get the scrollbar policy.
21954     *
21955     * @see elm_diskselector_scroller_policy_get() for details.
21956     *
21957     * @param obj The diskselector object.
21958     * @param policy_h Pointer where to store horizontal scrollbar policy.
21959     * @param policy_v Pointer where to store vertical scrollbar policy.
21960     *
21961     * @ingroup Diskselector
21962     */
21963    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);
21964
21965    /**
21966     * Set the scrollbar policy.
21967     *
21968     * @param obj The diskselector object.
21969     * @param policy_h Horizontal scrollbar policy.
21970     * @param policy_v Vertical scrollbar policy.
21971     *
21972     * This sets the scrollbar visibility policy for the given scroller.
21973     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
21974     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
21975     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
21976     * This applies respectively for the horizontal and vertical scrollbars.
21977     *
21978     * The both are disabled by default, i.e., are set to
21979     * #ELM_SCROLLER_POLICY_OFF.
21980     *
21981     * @ingroup Diskselector
21982     */
21983    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
21984
21985    /**
21986     * Remove all diskselector's items.
21987     *
21988     * @param obj The diskselector object.
21989     *
21990     * @see elm_diskselector_item_del()
21991     * @see elm_diskselector_item_append()
21992     *
21993     * @ingroup Diskselector
21994     */
21995    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21996
21997    /**
21998     * Get a list of all the diskselector items.
21999     *
22000     * @param obj The diskselector object.
22001     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22002     * or @c NULL on failure.
22003     *
22004     * @see elm_diskselector_item_append()
22005     * @see elm_diskselector_item_del()
22006     * @see elm_diskselector_clear()
22007     *
22008     * @ingroup Diskselector
22009     */
22010    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22011
22012    /**
22013     * Appends a new item to the diskselector object.
22014     *
22015     * @param obj The diskselector object.
22016     * @param label The label of the diskselector item.
22017     * @param icon The icon object to use at left side of the item. An
22018     * icon can be any Evas object, but usually it is an icon created
22019     * with elm_icon_add().
22020     * @param func The function to call when the item is selected.
22021     * @param data The data to associate with the item for related callbacks.
22022     *
22023     * @return The created item or @c NULL upon failure.
22024     *
22025     * A new item will be created and appended to the diskselector, i.e., will
22026     * be set as last item. Also, if there is no selected item, it will
22027     * be selected. This will always happens for the first appended item.
22028     *
22029     * If no icon is set, label will be centered on item position, otherwise
22030     * the icon will be placed at left of the label, that will be shifted
22031     * to the right.
22032     *
22033     * Items created with this method can be deleted with
22034     * elm_diskselector_item_del().
22035     *
22036     * Associated @p data can be properly freed when item is deleted if a
22037     * callback function is set with elm_diskselector_item_del_cb_set().
22038     *
22039     * If a function is passed as argument, it will be called everytime this item
22040     * is selected, i.e., the user stops the diskselector with this
22041     * item on center position. If such function isn't needed, just passing
22042     * @c NULL as @p func is enough. The same should be done for @p data.
22043     *
22044     * Simple example (with no function callback or data associated):
22045     * @code
22046     * disk = elm_diskselector_add(win);
22047     * ic = elm_icon_add(win);
22048     * elm_icon_file_set(ic, "path/to/image", NULL);
22049     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22050     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22051     * @endcode
22052     *
22053     * @see elm_diskselector_item_del()
22054     * @see elm_diskselector_item_del_cb_set()
22055     * @see elm_diskselector_clear()
22056     * @see elm_icon_add()
22057     *
22058     * @ingroup Diskselector
22059     */
22060    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);
22061
22062
22063    /**
22064     * Delete them item from the diskselector.
22065     *
22066     * @param it The item of diskselector to be deleted.
22067     *
22068     * If deleting all diskselector items is required, elm_diskselector_clear()
22069     * should be used instead of getting items list and deleting each one.
22070     *
22071     * @see elm_diskselector_clear()
22072     * @see elm_diskselector_item_append()
22073     * @see elm_diskselector_item_del_cb_set()
22074     *
22075     * @ingroup Diskselector
22076     */
22077    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22078
22079    /**
22080     * Set the function called when a diskselector item is freed.
22081     *
22082     * @param it The item to set the callback on
22083     * @param func The function called
22084     *
22085     * If there is a @p func, then it will be called prior item's memory release.
22086     * That will be called with the following arguments:
22087     * @li item's data;
22088     * @li item's Evas object;
22089     * @li item itself;
22090     *
22091     * This way, a data associated to a diskselector item could be properly
22092     * freed.
22093     *
22094     * @ingroup Diskselector
22095     */
22096    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22097
22098    /**
22099     * Get the data associated to the item.
22100     *
22101     * @param it The diskselector item
22102     * @return The data associated to @p it
22103     *
22104     * The return value is a pointer to data associated to @p item when it was
22105     * created, with function elm_diskselector_item_append(). If no data
22106     * was passed as argument, it will return @c NULL.
22107     *
22108     * @see elm_diskselector_item_append()
22109     *
22110     * @ingroup Diskselector
22111     */
22112    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22113
22114    /**
22115     * Set the icon associated to the item.
22116     *
22117     * @param it The diskselector item
22118     * @param icon The icon object to associate with @p it
22119     *
22120     * The icon object to use at left side of the item. An
22121     * icon can be any Evas object, but usually it is an icon created
22122     * with elm_icon_add().
22123     *
22124     * Once the icon object is set, a previously set one will be deleted.
22125     * @warning Setting the same icon for two items will cause the icon to
22126     * dissapear from the first item.
22127     *
22128     * If an icon was passed as argument on item creation, with function
22129     * elm_diskselector_item_append(), it will be already
22130     * associated to the item.
22131     *
22132     * @see elm_diskselector_item_append()
22133     * @see elm_diskselector_item_icon_get()
22134     *
22135     * @ingroup Diskselector
22136     */
22137    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22138
22139    /**
22140     * Get the icon associated to the item.
22141     *
22142     * @param it The diskselector item
22143     * @return The icon associated to @p it
22144     *
22145     * The return value is a pointer to the icon associated to @p item when it was
22146     * created, with function elm_diskselector_item_append(), or later
22147     * with function elm_diskselector_item_icon_set. If no icon
22148     * was passed as argument, it will return @c NULL.
22149     *
22150     * @see elm_diskselector_item_append()
22151     * @see elm_diskselector_item_icon_set()
22152     *
22153     * @ingroup Diskselector
22154     */
22155    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22156
22157    /**
22158     * Set the label of item.
22159     *
22160     * @param it The item of diskselector.
22161     * @param label The label of item.
22162     *
22163     * The label to be displayed by the item.
22164     *
22165     * If no icon is set, label will be centered on item position, otherwise
22166     * the icon will be placed at left of the label, that will be shifted
22167     * to the right.
22168     *
22169     * An item with label "January" would be displayed on side position as
22170     * "Jan" if max length is set to 3 with function
22171     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22172     * is set to 4.
22173     *
22174     * When this @p item is selected, the entire label will be displayed,
22175     * except for width restrictions.
22176     * In this case label will be cropped and "..." will be concatenated,
22177     * but only for display purposes. It will keep the entire string, so
22178     * if diskselector is resized the remaining characters will be displayed.
22179     *
22180     * If a label was passed as argument on item creation, with function
22181     * elm_diskselector_item_append(), it will be already
22182     * displayed by the item.
22183     *
22184     * @see elm_diskselector_side_label_lenght_set()
22185     * @see elm_diskselector_item_label_get()
22186     * @see elm_diskselector_item_append()
22187     *
22188     * @ingroup Diskselector
22189     */
22190    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22191
22192    /**
22193     * Get the label of item.
22194     *
22195     * @param it The item of diskselector.
22196     * @return The label of item.
22197     *
22198     * The return value is a pointer to the label associated to @p item when it was
22199     * created, with function elm_diskselector_item_append(), or later
22200     * with function elm_diskselector_item_label_set. If no label
22201     * was passed as argument, it will return @c NULL.
22202     *
22203     * @see elm_diskselector_item_label_set() for more details.
22204     * @see elm_diskselector_item_append()
22205     *
22206     * @ingroup Diskselector
22207     */
22208    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22209
22210    /**
22211     * Get the selected item.
22212     *
22213     * @param obj The diskselector object.
22214     * @return The selected diskselector item.
22215     *
22216     * The selected item can be unselected with function
22217     * elm_diskselector_item_selected_set(), and the first item of
22218     * diskselector will be selected.
22219     *
22220     * The selected item always will be centered on diskselector, with
22221     * full label displayed, i.e., max lenght set to side labels won't
22222     * apply on the selected item. More details on
22223     * elm_diskselector_side_label_length_set().
22224     *
22225     * @ingroup Diskselector
22226     */
22227    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22228
22229    /**
22230     * Set the selected state of an item.
22231     *
22232     * @param it The diskselector item
22233     * @param selected The selected state
22234     *
22235     * This sets the selected state of the given item @p it.
22236     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22237     *
22238     * If a new item is selected the previosly selected will be unselected.
22239     * Previoulsy selected item can be get with function
22240     * elm_diskselector_selected_item_get().
22241     *
22242     * If the item @p it is unselected, the first item of diskselector will
22243     * be selected.
22244     *
22245     * Selected items will be visible on center position of diskselector.
22246     * So if it was on another position before selected, or was invisible,
22247     * diskselector will animate items until the selected item reaches center
22248     * position.
22249     *
22250     * @see elm_diskselector_item_selected_get()
22251     * @see elm_diskselector_selected_item_get()
22252     *
22253     * @ingroup Diskselector
22254     */
22255    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22256
22257    /*
22258     * Get whether the @p item is selected or not.
22259     *
22260     * @param it The diskselector item.
22261     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22262     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22263     *
22264     * @see elm_diskselector_selected_item_set() for details.
22265     * @see elm_diskselector_item_selected_get()
22266     *
22267     * @ingroup Diskselector
22268     */
22269    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22270
22271    /**
22272     * Get the first item of the diskselector.
22273     *
22274     * @param obj The diskselector object.
22275     * @return The first item, or @c NULL if none.
22276     *
22277     * The list of items follows append order. So it will return the first
22278     * item appended to the widget that wasn't deleted.
22279     *
22280     * @see elm_diskselector_item_append()
22281     * @see elm_diskselector_items_get()
22282     *
22283     * @ingroup Diskselector
22284     */
22285    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22286
22287    /**
22288     * Get the last item of the diskselector.
22289     *
22290     * @param obj The diskselector object.
22291     * @return The last item, or @c NULL if none.
22292     *
22293     * The list of items follows append order. So it will return last first
22294     * item appended to the widget that wasn't deleted.
22295     *
22296     * @see elm_diskselector_item_append()
22297     * @see elm_diskselector_items_get()
22298     *
22299     * @ingroup Diskselector
22300     */
22301    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22302
22303    /**
22304     * Get the item before @p item in diskselector.
22305     *
22306     * @param it The diskselector item.
22307     * @return The item before @p item, or @c NULL if none or on failure.
22308     *
22309     * The list of items follows append order. So it will return item appended
22310     * just before @p item and that wasn't deleted.
22311     *
22312     * If it is the first item, @c NULL will be returned.
22313     * First item can be get by elm_diskselector_first_item_get().
22314     *
22315     * @see elm_diskselector_item_append()
22316     * @see elm_diskselector_items_get()
22317     *
22318     * @ingroup Diskselector
22319     */
22320    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22321
22322    /**
22323     * Get the item after @p item in diskselector.
22324     *
22325     * @param it The diskselector item.
22326     * @return The item after @p item, or @c NULL if none or on failure.
22327     *
22328     * The list of items follows append order. So it will return item appended
22329     * just after @p item and that wasn't deleted.
22330     *
22331     * If it is the last item, @c NULL will be returned.
22332     * Last item can be get by elm_diskselector_last_item_get().
22333     *
22334     * @see elm_diskselector_item_append()
22335     * @see elm_diskselector_items_get()
22336     *
22337     * @ingroup Diskselector
22338     */
22339    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22340
22341    /**
22342     * Set the text to be shown in the diskselector item.
22343     *
22344     * @param item Target item
22345     * @param text The text to set in the content
22346     *
22347     * Setup the text as tooltip to object. The item can have only one tooltip,
22348     * so any previous tooltip data is removed.
22349     *
22350     * @see elm_object_tooltip_text_set() for more details.
22351     *
22352     * @ingroup Diskselector
22353     */
22354    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22355
22356    /**
22357     * Set the content to be shown in the tooltip item.
22358     *
22359     * Setup the tooltip to item. The item can have only one tooltip,
22360     * so any previous tooltip data is removed. @p func(with @p data) will
22361     * be called every time that need show the tooltip and it should
22362     * return a valid Evas_Object. This object is then managed fully by
22363     * tooltip system and is deleted when the tooltip is gone.
22364     *
22365     * @param item the diskselector item being attached a tooltip.
22366     * @param func the function used to create the tooltip contents.
22367     * @param data what to provide to @a func as callback data/context.
22368     * @param del_cb called when data is not needed anymore, either when
22369     *        another callback replaces @p func, the tooltip is unset with
22370     *        elm_diskselector_item_tooltip_unset() or the owner @a item
22371     *        dies. This callback receives as the first parameter the
22372     *        given @a data, and @c event_info is the item.
22373     *
22374     * @see elm_object_tooltip_content_cb_set() for more details.
22375     *
22376     * @ingroup Diskselector
22377     */
22378    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);
22379
22380    /**
22381     * Unset tooltip from item.
22382     *
22383     * @param item diskselector item to remove previously set tooltip.
22384     *
22385     * Remove tooltip from item. The callback provided as del_cb to
22386     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22387     * it is not used anymore.
22388     *
22389     * @see elm_object_tooltip_unset() for more details.
22390     * @see elm_diskselector_item_tooltip_content_cb_set()
22391     *
22392     * @ingroup Diskselector
22393     */
22394    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22395
22396
22397    /**
22398     * Sets a different style for this item tooltip.
22399     *
22400     * @note before you set a style you should define a tooltip with
22401     *       elm_diskselector_item_tooltip_content_cb_set() or
22402     *       elm_diskselector_item_tooltip_text_set()
22403     *
22404     * @param item diskselector item with tooltip already set.
22405     * @param style the theme style to use (default, transparent, ...)
22406     *
22407     * @see elm_object_tooltip_style_set() for more details.
22408     *
22409     * @ingroup Diskselector
22410     */
22411    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22412
22413    /**
22414     * Get the style for this item tooltip.
22415     *
22416     * @param item diskselector item with tooltip already set.
22417     * @return style the theme style in use, defaults to "default". If the
22418     *         object does not have a tooltip set, then NULL is returned.
22419     *
22420     * @see elm_object_tooltip_style_get() for more details.
22421     * @see elm_diskselector_item_tooltip_style_set()
22422     *
22423     * @ingroup Diskselector
22424     */
22425    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22426
22427    /**
22428     * Set the cursor to be shown when mouse is over the diskselector item
22429     *
22430     * @param item Target item
22431     * @param cursor the cursor name to be used.
22432     *
22433     * @see elm_object_cursor_set() for more details.
22434     *
22435     * @ingroup Diskselector
22436     */
22437    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22438
22439    /**
22440     * Get the cursor to be shown when mouse is over the diskselector item
22441     *
22442     * @param item diskselector item with cursor already set.
22443     * @return the cursor name.
22444     *
22445     * @see elm_object_cursor_get() for more details.
22446     * @see elm_diskselector_cursor_set()
22447     *
22448     * @ingroup Diskselector
22449     */
22450    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22451
22452
22453    /**
22454     * Unset the cursor to be shown when mouse is over the diskselector item
22455     *
22456     * @param item Target item
22457     *
22458     * @see elm_object_cursor_unset() for more details.
22459     * @see elm_diskselector_cursor_set()
22460     *
22461     * @ingroup Diskselector
22462     */
22463    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22464
22465    /**
22466     * Sets a different style for this item cursor.
22467     *
22468     * @note before you set a style you should define a cursor with
22469     *       elm_diskselector_item_cursor_set()
22470     *
22471     * @param item diskselector item with cursor already set.
22472     * @param style the theme style to use (default, transparent, ...)
22473     *
22474     * @see elm_object_cursor_style_set() for more details.
22475     *
22476     * @ingroup Diskselector
22477     */
22478    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22479
22480
22481    /**
22482     * Get the style for this item cursor.
22483     *
22484     * @param item diskselector item with cursor already set.
22485     * @return style the theme style in use, defaults to "default". If the
22486     *         object does not have a cursor set, then @c NULL is returned.
22487     *
22488     * @see elm_object_cursor_style_get() for more details.
22489     * @see elm_diskselector_item_cursor_style_set()
22490     *
22491     * @ingroup Diskselector
22492     */
22493    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22494
22495
22496    /**
22497     * Set if the cursor set should be searched on the theme or should use
22498     * the provided by the engine, only.
22499     *
22500     * @note before you set if should look on theme you should define a cursor
22501     * with elm_diskselector_item_cursor_set().
22502     * By default it will only look for cursors provided by the engine.
22503     *
22504     * @param item widget item with cursor already set.
22505     * @param engine_only boolean to define if cursors set with
22506     * elm_diskselector_item_cursor_set() should be searched only
22507     * between cursors provided by the engine or searched on widget's
22508     * theme as well.
22509     *
22510     * @see elm_object_cursor_engine_only_set() for more details.
22511     *
22512     * @ingroup Diskselector
22513     */
22514    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22515
22516    /**
22517     * Get the cursor engine only usage for this item cursor.
22518     *
22519     * @param item widget item with cursor already set.
22520     * @return engine_only boolean to define it cursors should be looked only
22521     * between the provided by the engine or searched on widget's theme as well.
22522     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22523     *
22524     * @see elm_object_cursor_engine_only_get() for more details.
22525     * @see elm_diskselector_item_cursor_engine_only_set()
22526     *
22527     * @ingroup Diskselector
22528     */
22529    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22530
22531    /**
22532     * @}
22533     */
22534
22535    /**
22536     * @defgroup Colorselector Colorselector
22537     *
22538     * @{
22539     *
22540     * @image html img/widget/colorselector/preview-00.png
22541     *
22542     * @brief Widget for user to select a color.
22543     *
22544     * Signals that you can add callbacks for are:
22545     * "changed" - When the color value changes(event_info is NULL).
22546     *
22547     * See @ref tutorial_colorselector.
22548     */
22549    /**
22550     * @brief Add a new colorselector to the parent
22551     *
22552     * @param parent The parent object
22553     * @return The new object or NULL if it cannot be created
22554     *
22555     * @ingroup Colorselector
22556     */
22557    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22558    /**
22559     * Set a color for the colorselector
22560     *
22561     * @param obj   Colorselector object
22562     * @param r     r-value of color
22563     * @param g     g-value of color
22564     * @param b     b-value of color
22565     * @param a     a-value of color
22566     *
22567     * @ingroup Colorselector
22568     */
22569    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22570    /**
22571     * Get a color from the colorselector
22572     *
22573     * @param obj   Colorselector object
22574     * @param r     integer pointer for r-value of color
22575     * @param g     integer pointer for g-value of color
22576     * @param b     integer pointer for b-value of color
22577     * @param a     integer pointer for a-value of color
22578     *
22579     * @ingroup Colorselector
22580     */
22581    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22582    /**
22583     * @}
22584     */
22585
22586    /**
22587     * @defgroup Ctxpopup Ctxpopup
22588     *
22589     * @image html img/widget/ctxpopup/preview-00.png
22590     * @image latex img/widget/ctxpopup/preview-00.eps
22591     *
22592     * @brief Context popup widet.
22593     *
22594     * A ctxpopup is a widget that, when shown, pops up a list of items.
22595     * It automatically chooses an area inside its parent object's view
22596     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22597     * optimally fit into it. In the default theme, it will also point an
22598     * arrow to it's top left position at the time one shows it. Ctxpopup
22599     * items have a label and/or an icon. It is intended for a small
22600     * number of items (hence the use of list, not genlist).
22601     *
22602     * @note Ctxpopup is a especialization of @ref Hover.
22603     *
22604     * Signals that you can add callbacks for are:
22605     * "dismissed" - the ctxpopup was dismissed
22606     *
22607     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22608     * @{
22609     */
22610    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22611
22612    typedef enum _Elm_Ctxpopup_Direction
22613      {
22614         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22615                                           area */
22616         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22617                                            the clicked area */
22618         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22619                                           the clicked area */
22620         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22621                                         area */
22622      } Elm_Ctxpopup_Direction;
22623
22624    /**
22625     * @brief Add a new Ctxpopup object to the parent.
22626     *
22627     * @param parent Parent object
22628     * @return New object or @c NULL, if it cannot be created
22629     */
22630    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22631    /**
22632     * @brief Set the Ctxpopup's parent
22633     *
22634     * @param obj The ctxpopup object
22635     * @param area The parent to use
22636     *
22637     * Set the parent object.
22638     *
22639     * @note elm_ctxpopup_add() will automatically call this function
22640     * with its @c parent argument.
22641     *
22642     * @see elm_ctxpopup_add()
22643     * @see elm_hover_parent_set()
22644     */
22645    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22646    /**
22647     * @brief Get the Ctxpopup's parent
22648     *
22649     * @param obj The ctxpopup object
22650     *
22651     * @see elm_ctxpopup_hover_parent_set() for more information
22652     */
22653    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22654    /**
22655     * @brief Clear all items in the given ctxpopup object.
22656     *
22657     * @param obj Ctxpopup object
22658     */
22659    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22660    /**
22661     * @brief Change the ctxpopup's orientation to horizontal or vertical.
22662     *
22663     * @param obj Ctxpopup object
22664     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22665     */
22666    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22667    /**
22668     * @brief Get the value of current ctxpopup object's orientation.
22669     *
22670     * @param obj Ctxpopup object
22671     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22672     *
22673     * @see elm_ctxpopup_horizontal_set()
22674     */
22675    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22676    /**
22677     * @brief Add a new item to a ctxpopup object.
22678     *
22679     * @param obj Ctxpopup object
22680     * @param icon Icon to be set on new item
22681     * @param label The Label of the new item
22682     * @param func Convenience function called when item selected
22683     * @param data Data passed to @p func
22684     * @return A handle to the item added or @c NULL, on errors
22685     *
22686     * @warning Ctxpopup can't hold both an item list and a content at the same
22687     * time. When an item is added, any previous content will be removed.
22688     *
22689     * @see elm_ctxpopup_content_set()
22690     */
22691    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);
22692    /**
22693     * @brief Delete the given item in a ctxpopup object.
22694     *
22695     * @param item Ctxpopup item to be deleted
22696     *
22697     * @see elm_ctxpopup_item_append()
22698     */
22699    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22700    /**
22701     * @brief Set the ctxpopup item's state as disabled or enabled.
22702     *
22703     * @param item Ctxpopup item to be enabled/disabled
22704     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22705     *
22706     * When disabled the item is greyed out to indicate it's state.
22707     */
22708    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22709    /**
22710     * @brief Get the ctxpopup item's disabled/enabled state.
22711     *
22712     * @param item Ctxpopup item to be enabled/disabled
22713     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22714     *
22715     * @see elm_ctxpopup_item_disabled_set()
22716     */
22717    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22718    /**
22719     * @brief Get the icon object for the given ctxpopup item.
22720     *
22721     * @param item Ctxpopup item
22722     * @return icon object or @c NULL, if the item does not have icon or an error
22723     * occurred
22724     *
22725     * @see elm_ctxpopup_item_append()
22726     * @see elm_ctxpopup_item_icon_set()
22727     */
22728    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22729    /**
22730     * @brief Sets the side icon associated with the ctxpopup item
22731     *
22732     * @param item Ctxpopup item
22733     * @param icon Icon object to be set
22734     *
22735     * Once the icon object is set, a previously set one will be deleted.
22736     * @warning Setting the same icon for two items will cause the icon to
22737     * dissapear from the first item.
22738     *
22739     * @see elm_ctxpopup_item_append()
22740     */
22741    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22742    /**
22743     * @brief Get the label for the given ctxpopup item.
22744     *
22745     * @param item Ctxpopup item
22746     * @return label string or @c NULL, if the item does not have label or an
22747     * error occured
22748     *
22749     * @see elm_ctxpopup_item_append()
22750     * @see elm_ctxpopup_item_label_set()
22751     */
22752    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22753    /**
22754     * @brief (Re)set the label on the given ctxpopup item.
22755     *
22756     * @param item Ctxpopup item
22757     * @param label String to set as label
22758     */
22759    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22760    /**
22761     * @brief Set an elm widget as the content of the ctxpopup.
22762     *
22763     * @param obj Ctxpopup object
22764     * @param content Content to be swallowed
22765     *
22766     * If the content object is already set, a previous one will bedeleted. If
22767     * you want to keep that old content object, use the
22768     * elm_ctxpopup_content_unset() function.
22769     *
22770     * @deprecated use elm_object_content_set()
22771     *
22772     * @warning Ctxpopup can't hold both a item list and a content at the same
22773     * time. When a content is set, any previous items will be removed.
22774     */
22775    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22776    /**
22777     * @brief Unset the ctxpopup content
22778     *
22779     * @param obj Ctxpopup object
22780     * @return The content that was being used
22781     *
22782     * Unparent and return the content object which was set for this widget.
22783     *
22784     * @deprecated use elm_object_content_unset()
22785     *
22786     * @see elm_ctxpopup_content_set()
22787     */
22788    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22789    /**
22790     * @brief Set the direction priority of a ctxpopup.
22791     *
22792     * @param obj Ctxpopup object
22793     * @param first 1st priority of direction
22794     * @param second 2nd priority of direction
22795     * @param third 3th priority of direction
22796     * @param fourth 4th priority of direction
22797     *
22798     * This functions gives a chance to user to set the priority of ctxpopup
22799     * showing direction. This doesn't guarantee the ctxpopup will appear in the
22800     * requested direction.
22801     *
22802     * @see Elm_Ctxpopup_Direction
22803     */
22804    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);
22805    /**
22806     * @brief Get the direction priority of a ctxpopup.
22807     *
22808     * @param obj Ctxpopup object
22809     * @param first 1st priority of direction to be returned
22810     * @param second 2nd priority of direction to be returned
22811     * @param third 3th priority of direction to be returned
22812     * @param fourth 4th priority of direction to be returned
22813     *
22814     * @see elm_ctxpopup_direction_priority_set() for more information.
22815     */
22816    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);
22817    /**
22818     * @}
22819     */
22820
22821    /* transit */
22822    /**
22823     *
22824     * @defgroup Transit Transit
22825     * @ingroup Elementary
22826     *
22827     * Transit is designed to apply various animated transition effects to @c
22828     * Evas_Object, such like translation, rotation, etc. For using these
22829     * effects, create an @ref Elm_Transit and add the desired transition effects.
22830     *
22831     * Once the effects are added into transit, they will be automatically
22832     * managed (their callback will be called until the duration is ended, and
22833     * they will be deleted on completion).
22834     *
22835     * Example:
22836     * @code
22837     * Elm_Transit *trans = elm_transit_add();
22838     * elm_transit_object_add(trans, obj);
22839     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22840     * elm_transit_duration_set(transit, 1);
22841     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22842     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22843     * elm_transit_repeat_times_set(transit, 3);
22844     * @endcode
22845     *
22846     * Some transition effects are used to change the properties of objects. They
22847     * are:
22848     * @li @ref elm_transit_effect_translation_add
22849     * @li @ref elm_transit_effect_color_add
22850     * @li @ref elm_transit_effect_rotation_add
22851     * @li @ref elm_transit_effect_wipe_add
22852     * @li @ref elm_transit_effect_zoom_add
22853     * @li @ref elm_transit_effect_resizing_add
22854     *
22855     * Other transition effects are used to make one object disappear and another
22856     * object appear on its old place. These effects are:
22857     *
22858     * @li @ref elm_transit_effect_flip_add
22859     * @li @ref elm_transit_effect_resizable_flip_add
22860     * @li @ref elm_transit_effect_fade_add
22861     * @li @ref elm_transit_effect_blend_add
22862     *
22863     * It's also possible to make a transition chain with @ref
22864     * elm_transit_chain_transit_add.
22865     *
22866     * @warning We strongly recommend to use elm_transit just when edje can not do
22867     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22868     * animations can be manipulated inside the theme.
22869     *
22870     * List of examples:
22871     * @li @ref transit_example_01_explained
22872     * @li @ref transit_example_02_explained
22873     * @li @ref transit_example_03_c
22874     * @li @ref transit_example_04_c
22875     *
22876     * @{
22877     */
22878
22879    /**
22880     * @enum Elm_Transit_Tween_Mode
22881     *
22882     * The type of acceleration used in the transition.
22883     */
22884    typedef enum
22885      {
22886         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22887         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22888                                              over time, then decrease again
22889                                              and stop slowly */
22890         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22891                                              speed over time */
22892         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22893                                             over time */
22894      } Elm_Transit_Tween_Mode;
22895
22896    /**
22897     * @enum Elm_Transit_Effect_Flip_Axis
22898     *
22899     * The axis where flip effect should be applied.
22900     */
22901    typedef enum
22902      {
22903         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22904         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22905      } Elm_Transit_Effect_Flip_Axis;
22906    /**
22907     * @enum Elm_Transit_Effect_Wipe_Dir
22908     *
22909     * The direction where the wipe effect should occur.
22910     */
22911    typedef enum
22912      {
22913         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
22914         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
22915         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
22916         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
22917      } Elm_Transit_Effect_Wipe_Dir;
22918    /** @enum Elm_Transit_Effect_Wipe_Type
22919     *
22920     * Whether the wipe effect should show or hide the object.
22921     */
22922    typedef enum
22923      {
22924         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
22925                                              animation */
22926         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
22927                                             animation */
22928      } Elm_Transit_Effect_Wipe_Type;
22929
22930    /**
22931     * @typedef Elm_Transit
22932     *
22933     * The Transit created with elm_transit_add(). This type has the information
22934     * about the objects which the transition will be applied, and the
22935     * transition effects that will be used. It also contains info about
22936     * duration, number of repetitions, auto-reverse, etc.
22937     */
22938    typedef struct _Elm_Transit Elm_Transit;
22939    typedef void Elm_Transit_Effect;
22940    /**
22941     * @typedef Elm_Transit_Effect_Transition_Cb
22942     *
22943     * Transition callback called for this effect on each transition iteration.
22944     */
22945    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
22946    /**
22947     * Elm_Transit_Effect_End_Cb
22948     *
22949     * Transition callback called for this effect when the transition is over.
22950     */
22951    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
22952
22953    /**
22954     * Elm_Transit_Del_Cb
22955     *
22956     * A callback called when the transit is deleted.
22957     */
22958    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
22959
22960    /**
22961     * Add new transit.
22962     *
22963     * @note Is not necessary to delete the transit object, it will be deleted at
22964     * the end of its operation.
22965     * @note The transit will start playing when the program enter in the main loop, is not
22966     * necessary to give a start to the transit.
22967     *
22968     * @return The transit object.
22969     *
22970     * @ingroup Transit
22971     */
22972    EAPI Elm_Transit                *elm_transit_add(void);
22973
22974    /**
22975     * Stops the animation and delete the @p transit object.
22976     *
22977     * Call this function if you wants to stop the animation before the duration
22978     * time. Make sure the @p transit object is still alive with
22979     * elm_transit_del_cb_set() function.
22980     * All added effects will be deleted, calling its repective data_free_cb
22981     * functions. The function setted by elm_transit_del_cb_set() will be called.
22982     *
22983     * @see elm_transit_del_cb_set()
22984     *
22985     * @param transit The transit object to be deleted.
22986     *
22987     * @ingroup Transit
22988     * @warning Just call this function if you are sure the transit is alive.
22989     */
22990    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
22991
22992    /**
22993     * Add a new effect to the transit.
22994     *
22995     * @note The cb function and the data are the key to the effect. If you try to
22996     * add an already added effect, nothing is done.
22997     * @note After the first addition of an effect in @p transit, if its
22998     * effect list become empty again, the @p transit will be killed by
22999     * elm_transit_del(transit) function.
23000     *
23001     * Exemple:
23002     * @code
23003     * Elm_Transit *transit = elm_transit_add();
23004     * elm_transit_effect_add(transit,
23005     *                        elm_transit_effect_blend_op,
23006     *                        elm_transit_effect_blend_context_new(),
23007     *                        elm_transit_effect_blend_context_free);
23008     * @endcode
23009     *
23010     * @param transit The transit object.
23011     * @param transition_cb The operation function. It is called when the
23012     * animation begins, it is the function that actually performs the animation.
23013     * It is called with the @p data, @p transit and the time progression of the
23014     * animation (a double value between 0.0 and 1.0).
23015     * @param effect The context data of the effect.
23016     * @param end_cb The function to free the context data, it will be called
23017     * at the end of the effect, it must finalize the animation and free the
23018     * @p data.
23019     *
23020     * @ingroup Transit
23021     * @warning The transit free the context data at the and of the transition with
23022     * the data_free_cb function, do not use the context data in another transit.
23023     */
23024    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);
23025
23026    /**
23027     * Delete an added effect.
23028     *
23029     * This function will remove the effect from the @p transit, calling the
23030     * data_free_cb to free the @p data.
23031     *
23032     * @see elm_transit_effect_add()
23033     *
23034     * @note If the effect is not found, nothing is done.
23035     * @note If the effect list become empty, this function will call
23036     * elm_transit_del(transit), that is, it will kill the @p transit.
23037     *
23038     * @param transit The transit object.
23039     * @param transition_cb The operation function.
23040     * @param effect The context data of the effect.
23041     *
23042     * @ingroup Transit
23043     */
23044    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);
23045
23046    /**
23047     * Add new object to apply the effects.
23048     *
23049     * @note After the first addition of an object in @p transit, if its
23050     * object list become empty again, the @p transit will be killed by
23051     * elm_transit_del(transit) function.
23052     * @note If the @p obj belongs to another transit, the @p obj will be
23053     * removed from it and it will only belong to the @p transit. If the old
23054     * transit stays without objects, it will die.
23055     * @note When you add an object into the @p transit, its state from
23056     * evas_object_pass_events_get(obj) is saved, and it is applied when the
23057     * transit ends, if you change this state whith evas_object_pass_events_set()
23058     * after add the object, this state will change again when @p transit stops to
23059     * run.
23060     *
23061     * @param transit The transit object.
23062     * @param obj Object to be animated.
23063     *
23064     * @ingroup Transit
23065     * @warning It is not allowed to add a new object after transit begins to go.
23066     */
23067    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23068
23069    /**
23070     * Removes an added object from the transit.
23071     *
23072     * @note If the @p obj is not in the @p transit, nothing is done.
23073     * @note If the list become empty, this function will call
23074     * elm_transit_del(transit), that is, it will kill the @p transit.
23075     *
23076     * @param transit The transit object.
23077     * @param obj Object to be removed from @p transit.
23078     *
23079     * @ingroup Transit
23080     * @warning It is not allowed to remove objects after transit begins to go.
23081     */
23082    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23083
23084    /**
23085     * Get the objects of the transit.
23086     *
23087     * @param transit The transit object.
23088     * @return a Eina_List with the objects from the transit.
23089     *
23090     * @ingroup Transit
23091     */
23092    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23093
23094    /**
23095     * Enable/disable keeping up the objects states.
23096     * If it is not kept, the objects states will be reset when transition ends.
23097     *
23098     * @note @p transit can not be NULL.
23099     * @note One state includes geometry, color, map data.
23100     *
23101     * @param transit The transit object.
23102     * @param state_keep Keeping or Non Keeping.
23103     *
23104     * @ingroup Transit
23105     */
23106    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23107
23108    /**
23109     * Get a value whether the objects states will be reset or not.
23110     *
23111     * @note @p transit can not be NULL
23112     *
23113     * @see elm_transit_objects_final_state_keep_set()
23114     *
23115     * @param transit The transit object.
23116     * @return EINA_TRUE means the states of the objects will be reset.
23117     * If @p transit is NULL, EINA_FALSE is returned
23118     *
23119     * @ingroup Transit
23120     */
23121    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23122
23123    /**
23124     * Set the event enabled when transit is operating.
23125     *
23126     * If @p enabled is EINA_TRUE, the objects of the transit will receives
23127     * events from mouse and keyboard during the animation.
23128     * @note When you add an object with elm_transit_object_add(), its state from
23129     * evas_object_pass_events_get(obj) is saved, and it is applied when the
23130     * transit ends, if you change this state with evas_object_pass_events_set()
23131     * after adding the object, this state will change again when @p transit stops
23132     * to run.
23133     *
23134     * @param transit The transit object.
23135     * @param enabled Events are received when enabled is @c EINA_TRUE, and
23136     * ignored otherwise.
23137     *
23138     * @ingroup Transit
23139     */
23140    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23141
23142    /**
23143     * Get the value of event enabled status.
23144     *
23145     * @see elm_transit_event_enabled_set()
23146     *
23147     * @param transit The Transit object
23148     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23149     * EINA_FALSE is returned
23150     *
23151     * @ingroup Transit
23152     */
23153    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23154
23155    /**
23156     * Set the user-callback function when the transit is deleted.
23157     *
23158     * @note Using this function twice will overwrite the first function setted.
23159     * @note the @p transit object will be deleted after call @p cb function.
23160     *
23161     * @param transit The transit object.
23162     * @param cb Callback function pointer. This function will be called before
23163     * the deletion of the transit.
23164     * @param data Callback funtion user data. It is the @p op parameter.
23165     *
23166     * @ingroup Transit
23167     */
23168    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23169
23170    /**
23171     * Set reverse effect automatically.
23172     *
23173     * If auto reverse is setted, after running the effects with the progress
23174     * parameter from 0 to 1, it will call the effecs again with the progress
23175     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23176     * where the duration was setted with the function elm_transit_add and
23177     * the repeat with the function elm_transit_repeat_times_set().
23178     *
23179     * @param transit The transit object.
23180     * @param reverse EINA_TRUE means the auto_reverse is on.
23181     *
23182     * @ingroup Transit
23183     */
23184    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23185
23186    /**
23187     * Get if the auto reverse is on.
23188     *
23189     * @see elm_transit_auto_reverse_set()
23190     *
23191     * @param transit The transit object.
23192     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23193     * EINA_FALSE is returned
23194     *
23195     * @ingroup Transit
23196     */
23197    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23198
23199    /**
23200     * Set the transit repeat count. Effect will be repeated by repeat count.
23201     *
23202     * This function sets the number of repetition the transit will run after
23203     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23204     * If the @p repeat is a negative number, it will repeat infinite times.
23205     *
23206     * @note If this function is called during the transit execution, the transit
23207     * will run @p repeat times, ignoring the times it already performed.
23208     *
23209     * @param transit The transit object
23210     * @param repeat Repeat count
23211     *
23212     * @ingroup Transit
23213     */
23214    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23215
23216    /**
23217     * Get the transit repeat count.
23218     *
23219     * @see elm_transit_repeat_times_set()
23220     *
23221     * @param transit The Transit object.
23222     * @return The repeat count. If @p transit is NULL
23223     * 0 is returned
23224     *
23225     * @ingroup Transit
23226     */
23227    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23228
23229    /**
23230     * Set the transit animation acceleration type.
23231     *
23232     * This function sets the tween mode of the transit that can be:
23233     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23234     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23235     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23236     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23237     *
23238     * @param transit The transit object.
23239     * @param tween_mode The tween type.
23240     *
23241     * @ingroup Transit
23242     */
23243    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23244
23245    /**
23246     * Get the transit animation acceleration type.
23247     *
23248     * @note @p transit can not be NULL
23249     *
23250     * @param transit The transit object.
23251     * @return The tween type. If @p transit is NULL
23252     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23253     *
23254     * @ingroup Transit
23255     */
23256    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23257
23258    /**
23259     * Set the transit animation time
23260     *
23261     * @note @p transit can not be NULL
23262     *
23263     * @param transit The transit object.
23264     * @param duration The animation time.
23265     *
23266     * @ingroup Transit
23267     */
23268    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23269
23270    /**
23271     * Get the transit animation time
23272     *
23273     * @note @p transit can not be NULL
23274     *
23275     * @param transit The transit object.
23276     *
23277     * @return The transit animation time.
23278     *
23279     * @ingroup Transit
23280     */
23281    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23282
23283    /**
23284     * Starts the transition.
23285     * Once this API is called, the transit begins to measure the time.
23286     *
23287     * @note @p transit can not be NULL
23288     *
23289     * @param transit The transit object.
23290     *
23291     * @ingroup Transit
23292     */
23293    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23294
23295    /**
23296     * Pause/Resume the transition.
23297     *
23298     * If you call elm_transit_go again, the transit will be started from the
23299     * beginning, and will be unpaused.
23300     *
23301     * @note @p transit can not be NULL
23302     *
23303     * @param transit The transit object.
23304     * @param paused Whether the transition should be paused or not.
23305     *
23306     * @ingroup Transit
23307     */
23308    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23309
23310    /**
23311     * Get the value of paused status.
23312     *
23313     * @see elm_transit_paused_set()
23314     *
23315     * @note @p transit can not be NULL
23316     *
23317     * @param transit The transit object.
23318     * @return EINA_TRUE means transition is paused. If @p transit is NULL
23319     * EINA_FALSE is returned
23320     *
23321     * @ingroup Transit
23322     */
23323    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23324
23325    /**
23326     * Get the time progression of the animation (a double value between 0.0 and 1.0).
23327     *
23328     * The value returned is a fraction (current time / total time). It
23329     * represents the progression position relative to the total.
23330     *
23331     * @note @p transit can not be NULL
23332     *
23333     * @param transit The transit object.
23334     *
23335     * @return The time progression value. If @p transit is NULL
23336     * 0 is returned
23337     *
23338     * @ingroup Transit
23339     */
23340    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23341
23342    /**
23343     * Makes the chain relationship between two transits.
23344     *
23345     * @note @p transit can not be NULL. Transit would have multiple chain transits.
23346     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23347     *
23348     * @param transit The transit object.
23349     * @param chain_transit The chain transit object. This transit will be operated
23350     *        after transit is done.
23351     *
23352     * This function adds @p chain_transit transition to a chain after the @p
23353     * transit, and will be started as soon as @p transit ends. See @ref
23354     * transit_example_02_explained for a full example.
23355     *
23356     * @ingroup Transit
23357     */
23358    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23359
23360    /**
23361     * Cut off the chain relationship between two transits.
23362     *
23363     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23364     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23365     *
23366     * @param transit The transit object.
23367     * @param chain_transit The chain transit object.
23368     *
23369     * This function remove the @p chain_transit transition from the @p transit.
23370     *
23371     * @ingroup Transit
23372     */
23373    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23374
23375    /**
23376     * Get the current chain transit list.
23377     *
23378     * @note @p transit can not be NULL.
23379     *
23380     * @param transit The transit object.
23381     * @return chain transit list.
23382     *
23383     * @ingroup Transit
23384     */
23385    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
23386
23387    /**
23388     * Add the Resizing Effect to Elm_Transit.
23389     *
23390     * @note This API is one of the facades. It creates resizing effect context
23391     * and add it's required APIs to elm_transit_effect_add.
23392     *
23393     * @see elm_transit_effect_add()
23394     *
23395     * @param transit Transit object.
23396     * @param from_w Object width size when effect begins.
23397     * @param from_h Object height size when effect begins.
23398     * @param to_w Object width size when effect ends.
23399     * @param to_h Object height size when effect ends.
23400     * @return Resizing effect context data.
23401     *
23402     * @ingroup Transit
23403     */
23404    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);
23405
23406    /**
23407     * Add the Translation Effect to Elm_Transit.
23408     *
23409     * @note This API is one of the facades. It creates translation effect context
23410     * and add it's required APIs to elm_transit_effect_add.
23411     *
23412     * @see elm_transit_effect_add()
23413     *
23414     * @param transit Transit object.
23415     * @param from_dx X Position variation when effect begins.
23416     * @param from_dy Y Position variation when effect begins.
23417     * @param to_dx X Position variation when effect ends.
23418     * @param to_dy Y Position variation when effect ends.
23419     * @return Translation effect context data.
23420     *
23421     * @ingroup Transit
23422     * @warning It is highly recommended just create a transit with this effect when
23423     * the window that the objects of the transit belongs has already been created.
23424     * This is because this effect needs the geometry information about the objects,
23425     * and if the window was not created yet, it can get a wrong information.
23426     */
23427    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);
23428
23429    /**
23430     * Add the Zoom Effect to Elm_Transit.
23431     *
23432     * @note This API is one of the facades. It creates zoom effect context
23433     * and add it's required APIs to elm_transit_effect_add.
23434     *
23435     * @see elm_transit_effect_add()
23436     *
23437     * @param transit Transit object.
23438     * @param from_rate Scale rate when effect begins (1 is current rate).
23439     * @param to_rate Scale rate when effect ends.
23440     * @return Zoom effect context data.
23441     *
23442     * @ingroup Transit
23443     * @warning It is highly recommended just create a transit with this effect when
23444     * the window that the objects of the transit belongs has already been created.
23445     * This is because this effect needs the geometry information about the objects,
23446     * and if the window was not created yet, it can get a wrong information.
23447     */
23448    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23449
23450    /**
23451     * Add the Flip Effect to Elm_Transit.
23452     *
23453     * @note This API is one of the facades. It creates flip effect context
23454     * and add it's required APIs to elm_transit_effect_add.
23455     * @note This effect is applied to each pair of objects in the order they are listed
23456     * in the transit list of objects. The first object in the pair will be the
23457     * "front" object and the second will be the "back" object.
23458     *
23459     * @see elm_transit_effect_add()
23460     *
23461     * @param transit Transit object.
23462     * @param axis Flipping Axis(X or Y).
23463     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23464     * @return Flip effect context data.
23465     *
23466     * @ingroup Transit
23467     * @warning It is highly recommended just create a transit with this effect when
23468     * the window that the objects of the transit belongs has already been created.
23469     * This is because this effect needs the geometry information about the objects,
23470     * and if the window was not created yet, it can get a wrong information.
23471     */
23472    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23473
23474    /**
23475     * Add the Resizable Flip Effect to Elm_Transit.
23476     *
23477     * @note This API is one of the facades. It creates resizable flip effect context
23478     * and add it's required APIs to elm_transit_effect_add.
23479     * @note This effect is applied to each pair of objects in the order they are listed
23480     * in the transit list of objects. The first object in the pair will be the
23481     * "front" object and the second will be the "back" object.
23482     *
23483     * @see elm_transit_effect_add()
23484     *
23485     * @param transit Transit object.
23486     * @param axis Flipping Axis(X or Y).
23487     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23488     * @return Resizable flip effect context data.
23489     *
23490     * @ingroup Transit
23491     * @warning It is highly recommended just create a transit with this effect when
23492     * the window that the objects of the transit belongs has already been created.
23493     * This is because this effect needs the geometry information about the objects,
23494     * and if the window was not created yet, it can get a wrong information.
23495     */
23496    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23497
23498    /**
23499     * Add the Wipe Effect to Elm_Transit.
23500     *
23501     * @note This API is one of the facades. It creates wipe effect context
23502     * and add it's required APIs to elm_transit_effect_add.
23503     *
23504     * @see elm_transit_effect_add()
23505     *
23506     * @param transit Transit object.
23507     * @param type Wipe type. Hide or show.
23508     * @param dir Wipe Direction.
23509     * @return Wipe effect context data.
23510     *
23511     * @ingroup Transit
23512     * @warning It is highly recommended just create a transit with this effect when
23513     * the window that the objects of the transit belongs has already been created.
23514     * This is because this effect needs the geometry information about the objects,
23515     * and if the window was not created yet, it can get a wrong information.
23516     */
23517    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23518
23519    /**
23520     * Add the Color Effect to Elm_Transit.
23521     *
23522     * @note This API is one of the facades. It creates color effect context
23523     * and add it's required APIs to elm_transit_effect_add.
23524     *
23525     * @see elm_transit_effect_add()
23526     *
23527     * @param transit        Transit object.
23528     * @param  from_r        RGB R when effect begins.
23529     * @param  from_g        RGB G when effect begins.
23530     * @param  from_b        RGB B when effect begins.
23531     * @param  from_a        RGB A when effect begins.
23532     * @param  to_r          RGB R when effect ends.
23533     * @param  to_g          RGB G when effect ends.
23534     * @param  to_b          RGB B when effect ends.
23535     * @param  to_a          RGB A when effect ends.
23536     * @return               Color effect context data.
23537     *
23538     * @ingroup Transit
23539     */
23540    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);
23541
23542    /**
23543     * Add the Fade Effect to Elm_Transit.
23544     *
23545     * @note This API is one of the facades. It creates fade effect context
23546     * and add it's required APIs to elm_transit_effect_add.
23547     * @note This effect is applied to each pair of objects in the order they are listed
23548     * in the transit list of objects. The first object in the pair will be the
23549     * "before" object and the second will be the "after" object.
23550     *
23551     * @see elm_transit_effect_add()
23552     *
23553     * @param transit Transit object.
23554     * @return Fade effect context data.
23555     *
23556     * @ingroup Transit
23557     * @warning It is highly recommended just create a transit with this effect when
23558     * the window that the objects of the transit belongs has already been created.
23559     * This is because this effect needs the color information about the objects,
23560     * and if the window was not created yet, it can get a wrong information.
23561     */
23562    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23563
23564    /**
23565     * Add the Blend Effect to Elm_Transit.
23566     *
23567     * @note This API is one of the facades. It creates blend effect context
23568     * and add it's required APIs to elm_transit_effect_add.
23569     * @note This effect is applied to each pair of objects in the order they are listed
23570     * in the transit list of objects. The first object in the pair will be the
23571     * "before" object and the second will be the "after" object.
23572     *
23573     * @see elm_transit_effect_add()
23574     *
23575     * @param transit Transit object.
23576     * @return Blend effect context data.
23577     *
23578     * @ingroup Transit
23579     * @warning It is highly recommended just create a transit with this effect when
23580     * the window that the objects of the transit belongs has already been created.
23581     * This is because this effect needs the color information about the objects,
23582     * and if the window was not created yet, it can get a wrong information.
23583     */
23584    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23585
23586    /**
23587     * Add the Rotation Effect to Elm_Transit.
23588     *
23589     * @note This API is one of the facades. It creates rotation effect context
23590     * and add it's required APIs to elm_transit_effect_add.
23591     *
23592     * @see elm_transit_effect_add()
23593     *
23594     * @param transit Transit object.
23595     * @param from_degree Degree when effect begins.
23596     * @param to_degree Degree when effect is ends.
23597     * @return Rotation effect context data.
23598     *
23599     * @ingroup Transit
23600     * @warning It is highly recommended just create a transit with this effect when
23601     * the window that the objects of the transit belongs has already been created.
23602     * This is because this effect needs the geometry information about the objects,
23603     * and if the window was not created yet, it can get a wrong information.
23604     */
23605    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23606
23607    /**
23608     * Add the ImageAnimation Effect to Elm_Transit.
23609     *
23610     * @note This API is one of the facades. It creates image animation effect context
23611     * and add it's required APIs to elm_transit_effect_add.
23612     * The @p images parameter is a list images paths. This list and
23613     * its contents will be deleted at the end of the effect by
23614     * elm_transit_effect_image_animation_context_free() function.
23615     *
23616     * Example:
23617     * @code
23618     * char buf[PATH_MAX];
23619     * Eina_List *images = NULL;
23620     * Elm_Transit *transi = elm_transit_add();
23621     *
23622     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23623     * images = eina_list_append(images, eina_stringshare_add(buf));
23624     *
23625     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23626     * images = eina_list_append(images, eina_stringshare_add(buf));
23627     * elm_transit_effect_image_animation_add(transi, images);
23628     *
23629     * @endcode
23630     *
23631     * @see elm_transit_effect_add()
23632     *
23633     * @param transit Transit object.
23634     * @param images Eina_List of images file paths. This list and
23635     * its contents will be deleted at the end of the effect by
23636     * elm_transit_effect_image_animation_context_free() function.
23637     * @return Image Animation effect context data.
23638     *
23639     * @ingroup Transit
23640     */
23641    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23642    /**
23643     * @}
23644     */
23645
23646   typedef struct _Elm_Store                      Elm_Store;
23647   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
23648   typedef struct _Elm_Store_Item                 Elm_Store_Item;
23649   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
23650   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
23651   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23652   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
23653   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
23654   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
23655   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
23656   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
23657
23658   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23659   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23660   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23661   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23662
23663   typedef enum
23664     {
23665        ELM_STORE_ITEM_MAPPING_NONE = 0,
23666        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23667        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23668        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23669        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23670        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23671        // can add more here as needed by common apps
23672        ELM_STORE_ITEM_MAPPING_LAST
23673     } Elm_Store_Item_Mapping_Type;
23674
23675   struct _Elm_Store_Item_Mapping_Icon
23676     {
23677        // FIXME: allow edje file icons
23678        int                   w, h;
23679        Elm_Icon_Lookup_Order lookup_order;
23680        Eina_Bool             standard_name : 1;
23681        Eina_Bool             no_scale : 1;
23682        Eina_Bool             smooth : 1;
23683        Eina_Bool             scale_up : 1;
23684        Eina_Bool             scale_down : 1;
23685     };
23686
23687   struct _Elm_Store_Item_Mapping_Empty
23688     {
23689        Eina_Bool             dummy;
23690     };
23691
23692   struct _Elm_Store_Item_Mapping_Photo
23693     {
23694        int                   size;
23695     };
23696
23697   struct _Elm_Store_Item_Mapping_Custom
23698     {
23699        Elm_Store_Item_Mapping_Cb func;
23700     };
23701
23702   struct _Elm_Store_Item_Mapping
23703     {
23704        Elm_Store_Item_Mapping_Type     type;
23705        const char                     *part;
23706        int                             offset;
23707        union
23708          {
23709             Elm_Store_Item_Mapping_Empty  empty;
23710             Elm_Store_Item_Mapping_Icon   icon;
23711             Elm_Store_Item_Mapping_Photo  photo;
23712             Elm_Store_Item_Mapping_Custom custom;
23713             // add more types here
23714          } details;
23715     };
23716
23717   struct _Elm_Store_Item_Info
23718     {
23719       Elm_Genlist_Item_Class       *item_class;
23720       const Elm_Store_Item_Mapping *mapping;
23721       void                         *data;
23722       char                         *sort_id;
23723     };
23724
23725   struct _Elm_Store_Item_Info_Filesystem
23726     {
23727       Elm_Store_Item_Info  base;
23728       char                *path;
23729     };
23730
23731 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23732 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23733
23734   EAPI void                    elm_store_free(Elm_Store *st);
23735
23736   EAPI Elm_Store              *elm_store_filesystem_new(void);
23737   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23738   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23739   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23740
23741   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23742
23743   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23744   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23745   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23746   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23747   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23748   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23749
23750   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23751   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23752   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23753   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23754   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23755   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23756   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23757
23758    /**
23759     * @defgroup SegmentControl SegmentControl
23760     * @ingroup Elementary
23761     *
23762     * @image html img/widget/segment_control/preview-00.png
23763     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23764     *
23765     * @image html img/segment_control.png
23766     * @image latex img/segment_control.eps width=\textwidth
23767     *
23768     * Segment control widget is a horizontal control made of multiple segment
23769     * items, each segment item functioning similar to discrete two state button.
23770     * A segment control groups the items together and provides compact
23771     * single button with multiple equal size segments.
23772     *
23773     * Segment item size is determined by base widget
23774     * size and the number of items added.
23775     * Only one segment item can be at selected state. A segment item can display
23776     * combination of Text and any Evas_Object like Images or other widget.
23777     *
23778     * Smart callbacks one can listen to:
23779     * - "changed" - When the user clicks on a segment item which is not
23780     *   previously selected and get selected. The event_info parameter is the
23781     *   segment item index.
23782     *
23783     * Available styles for it:
23784     * - @c "default"
23785     *
23786     * Here is an example on its usage:
23787     * @li @ref segment_control_example
23788     */
23789
23790    /**
23791     * @addtogroup SegmentControl
23792     * @{
23793     */
23794
23795    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23796
23797    /**
23798     * Add a new segment control widget to the given parent Elementary
23799     * (container) object.
23800     *
23801     * @param parent The parent object.
23802     * @return a new segment control widget handle or @c NULL, on errors.
23803     *
23804     * This function inserts a new segment control widget on the canvas.
23805     *
23806     * @ingroup SegmentControl
23807     */
23808    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23809
23810    /**
23811     * Append a new item to the segment control object.
23812     *
23813     * @param obj The segment control object.
23814     * @param icon The icon object to use for the left side of the item. An
23815     * icon can be any Evas object, but usually it is an icon created
23816     * with elm_icon_add().
23817     * @param label The label of the item.
23818     *        Note that, NULL is different from empty string "".
23819     * @return The created item or @c NULL upon failure.
23820     *
23821     * A new item will be created and appended to the segment control, i.e., will
23822     * be set as @b last item.
23823     *
23824     * If it should be inserted at another position,
23825     * elm_segment_control_item_insert_at() should be used instead.
23826     *
23827     * Items created with this function can be deleted with function
23828     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23829     *
23830     * @note @p label set to @c NULL is different from empty string "".
23831     * If an item
23832     * only has icon, it will be displayed bigger and centered. If it has
23833     * icon and label, even that an empty string, icon will be smaller and
23834     * positioned at left.
23835     *
23836     * Simple example:
23837     * @code
23838     * sc = elm_segment_control_add(win);
23839     * ic = elm_icon_add(win);
23840     * elm_icon_file_set(ic, "path/to/image", NULL);
23841     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23842     * elm_segment_control_item_add(sc, ic, "label");
23843     * evas_object_show(sc);
23844     * @endcode
23845     *
23846     * @see elm_segment_control_item_insert_at()
23847     * @see elm_segment_control_item_del()
23848     *
23849     * @ingroup SegmentControl
23850     */
23851    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23852
23853    /**
23854     * Insert a new item to the segment control object at specified position.
23855     *
23856     * @param obj The segment control object.
23857     * @param icon The icon object to use for the left side of the item. An
23858     * icon can be any Evas object, but usually it is an icon created
23859     * with elm_icon_add().
23860     * @param label The label of the item.
23861     * @param index Item position. Value should be between 0 and items count.
23862     * @return The created item or @c NULL upon failure.
23863
23864     * Index values must be between @c 0, when item will be prepended to
23865     * segment control, and items count, that can be get with
23866     * elm_segment_control_item_count_get(), case when item will be appended
23867     * to segment control, just like elm_segment_control_item_add().
23868     *
23869     * Items created with this function can be deleted with function
23870     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23871     *
23872     * @note @p label set to @c NULL is different from empty string "".
23873     * If an item
23874     * only has icon, it will be displayed bigger and centered. If it has
23875     * icon and label, even that an empty string, icon will be smaller and
23876     * positioned at left.
23877     *
23878     * @see elm_segment_control_item_add()
23879     * @see elm_segment_control_count_get()
23880     * @see elm_segment_control_item_del()
23881     *
23882     * @ingroup SegmentControl
23883     */
23884    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);
23885
23886    /**
23887     * Remove a segment control item from its parent, deleting it.
23888     *
23889     * @param it The item to be removed.
23890     *
23891     * Items can be added with elm_segment_control_item_add() or
23892     * elm_segment_control_item_insert_at().
23893     *
23894     * @ingroup SegmentControl
23895     */
23896    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23897
23898    /**
23899     * Remove a segment control item at given index from its parent,
23900     * deleting it.
23901     *
23902     * @param obj The segment control object.
23903     * @param index The position of the segment control item to be deleted.
23904     *
23905     * Items can be added with elm_segment_control_item_add() or
23906     * elm_segment_control_item_insert_at().
23907     *
23908     * @ingroup SegmentControl
23909     */
23910    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23911
23912    /**
23913     * Get the Segment items count from segment control.
23914     *
23915     * @param obj The segment control object.
23916     * @return Segment items count.
23917     *
23918     * It will just return the number of items added to segment control @p obj.
23919     *
23920     * @ingroup SegmentControl
23921     */
23922    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23923
23924    /**
23925     * Get the item placed at specified index.
23926     *
23927     * @param obj The segment control object.
23928     * @param index The index of the segment item.
23929     * @return The segment control item or @c NULL on failure.
23930     *
23931     * Index is the position of an item in segment control widget. Its
23932     * range is from @c 0 to <tt> count - 1 </tt>.
23933     * Count is the number of items, that can be get with
23934     * elm_segment_control_item_count_get().
23935     *
23936     * @ingroup SegmentControl
23937     */
23938    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23939
23940    /**
23941     * Get the label of item.
23942     *
23943     * @param obj The segment control object.
23944     * @param index The index of the segment item.
23945     * @return The label of the item at @p index.
23946     *
23947     * The return value is a pointer to the label associated to the item when
23948     * it was created, with function elm_segment_control_item_add(), or later
23949     * with function elm_segment_control_item_label_set. If no label
23950     * was passed as argument, it will return @c NULL.
23951     *
23952     * @see elm_segment_control_item_label_set() for more details.
23953     * @see elm_segment_control_item_add()
23954     *
23955     * @ingroup SegmentControl
23956     */
23957    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23958
23959    /**
23960     * Set the label of item.
23961     *
23962     * @param it The item of segment control.
23963     * @param text The label of item.
23964     *
23965     * The label to be displayed by the item.
23966     * Label will be at right of the icon (if set).
23967     *
23968     * If a label was passed as argument on item creation, with function
23969     * elm_control_segment_item_add(), it will be already
23970     * displayed by the item.
23971     *
23972     * @see elm_segment_control_item_label_get()
23973     * @see elm_segment_control_item_add()
23974     *
23975     * @ingroup SegmentControl
23976     */
23977    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
23978
23979    /**
23980     * Get the icon associated to the item.
23981     *
23982     * @param obj The segment control object.
23983     * @param index The index of the segment item.
23984     * @return The left side icon associated to the item at @p index.
23985     *
23986     * The return value is a pointer to the icon associated to the item when
23987     * it was created, with function elm_segment_control_item_add(), or later
23988     * with function elm_segment_control_item_icon_set(). If no icon
23989     * was passed as argument, it will return @c NULL.
23990     *
23991     * @see elm_segment_control_item_add()
23992     * @see elm_segment_control_item_icon_set()
23993     *
23994     * @ingroup SegmentControl
23995     */
23996    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23997
23998    /**
23999     * Set the icon associated to the item.
24000     *
24001     * @param it The segment control item.
24002     * @param icon The icon object to associate with @p it.
24003     *
24004     * The icon object to use at left side of the item. An
24005     * icon can be any Evas object, but usually it is an icon created
24006     * with elm_icon_add().
24007     *
24008     * Once the icon object is set, a previously set one will be deleted.
24009     * @warning Setting the same icon for two items will cause the icon to
24010     * dissapear from the first item.
24011     *
24012     * If an icon was passed as argument on item creation, with function
24013     * elm_segment_control_item_add(), it will be already
24014     * associated to the item.
24015     *
24016     * @see elm_segment_control_item_add()
24017     * @see elm_segment_control_item_icon_get()
24018     *
24019     * @ingroup SegmentControl
24020     */
24021    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24022
24023    /**
24024     * Get the index of an item.
24025     *
24026     * @param it The segment control item.
24027     * @return The position of item in segment control widget.
24028     *
24029     * Index is the position of an item in segment control widget. Its
24030     * range is from @c 0 to <tt> count - 1 </tt>.
24031     * Count is the number of items, that can be get with
24032     * elm_segment_control_item_count_get().
24033     *
24034     * @ingroup SegmentControl
24035     */
24036    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24037
24038    /**
24039     * Get the base object of the item.
24040     *
24041     * @param it The segment control item.
24042     * @return The base object associated with @p it.
24043     *
24044     * Base object is the @c Evas_Object that represents that item.
24045     *
24046     * @ingroup SegmentControl
24047     */
24048    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24049
24050    /**
24051     * Get the selected item.
24052     *
24053     * @param obj The segment control object.
24054     * @return The selected item or @c NULL if none of segment items is
24055     * selected.
24056     *
24057     * The selected item can be unselected with function
24058     * elm_segment_control_item_selected_set().
24059     *
24060     * The selected item always will be highlighted on segment control.
24061     *
24062     * @ingroup SegmentControl
24063     */
24064    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24065
24066    /**
24067     * Set the selected state of an item.
24068     *
24069     * @param it The segment control item
24070     * @param select The selected state
24071     *
24072     * This sets the selected state of the given item @p it.
24073     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24074     *
24075     * If a new item is selected the previosly selected will be unselected.
24076     * Previoulsy selected item can be get with function
24077     * elm_segment_control_item_selected_get().
24078     *
24079     * The selected item always will be highlighted on segment control.
24080     *
24081     * @see elm_segment_control_item_selected_get()
24082     *
24083     * @ingroup SegmentControl
24084     */
24085    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24086
24087    /**
24088     * @}
24089     */
24090
24091
24092    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24093    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
24094    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24095    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24096    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24097    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24098    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24099    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24100
24101    EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
24102    EAPI void         elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
24103
24104    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24105    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24106    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24107    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24108    EAPI void elm_video_play(Evas_Object *video);
24109    EAPI void elm_video_pause(Evas_Object *video);
24110    EAPI void elm_video_stop(Evas_Object *video);
24111    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24112    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24113    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24114    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24115    EAPI double elm_video_audio_level_get(Evas_Object *video);
24116    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24117    EAPI double elm_video_play_position_get(Evas_Object *video);
24118    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24119    EAPI double elm_video_play_length_get(Evas_Object *video);
24120    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24121    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24122    EAPI const char *elm_video_title_get(Evas_Object *video);
24123
24124    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24125    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24126
24127   /* naviframe */
24128    typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
24129
24130    typedef enum
24131      {
24132         ELM_NAVIFRAME_PREV_BUTTON,
24133         ELM_NAVIFRAME_NEXT_BUTTON
24134      } Elm_Naviframe_Button_Type;
24135
24136    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24137    EAPI Elm_Naviframe_Item *elm_naviframe_item_push(Evas_Object *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
24138    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24139    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24140    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24141    EAPI void                elm_naviframe_item_content_set(Elm_Naviframe_Item *item, Evas_Object *content) EINA_ARG_NONNULL(1);
24142    EAPI Evas_Object        *elm_naviframe_item_content_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24143    EAPI void                elm_naviframe_item_title_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
24144    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24145    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Naviframe_Item *it, const char *label) EINA_ARG_NONNULL(1);
24146    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24147    EAPI Elm_Naviframe_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24148    EAPI Elm_Naviframe_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24149    EAPI void                elm_naviframe_item_button_set(Elm_Naviframe_Item *it, Evas_Object *btn, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
24150    EAPI Evas_Object        *elm_naviframe_item_button_get(const Elm_Naviframe_Item *it, Elm_Naviframe_Button_Type btn_type) EINA_ARG_NONNULL(1);
24151    EAPI void                elm_naviframe_item_icon_set(Elm_Naviframe_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24152    EAPI Evas_Object        *elm_naviframe_item_icon_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24153    EAPI void                elm_naviframe_item_style_set(Elm_Naviframe_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24154    EAPI const char         *elm_naviframe_item_style_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24155    EAPI void                elm_naviframe_item_title_visible_set(Elm_Naviframe_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24156    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Naviframe_Item *it) EINA_ARG_NONNULL(1);
24157
24158 #ifdef __cplusplus
24159 }
24160 #endif
24161
24162 #endif