Elementary: adding some missing widget previews for pdf.
[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 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @section organization Organization
26
27 One can divide Elemementary into three main groups:
28 @li @ref infralist - These are modules that deal with Elementary as a whole.
29 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
30 @li @ref containerslist - These are the containers in which the widgets will be
31                           layouted.
32
33 @section license License
34
35 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
36 all files in the source tree.
37
38 @section ack Acknowledgements
39 There is a lot that goes into making a widget set, and they don't happen out of
40 nothing. It's like trying to make everyone everywhere happy, regardless of age,
41 gender, race or nationality - and that is really tough. So thanks to people and
42 organisations behind this, as listed in the @ref authors page.
43 */
44
45 /**
46 @page authors Authors
47 @author Carsten Haitzler <raster@@rasterman.com>
48 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
49 @author Cedric Bail <cedric.bail@@free.fr>
50 @author Vincent Torri <vtorri@@univ-evry.fr>
51 @author Daniel Kolesa <quaker66@@gmail.com>
52 @author Jaime Thomas <avi.thomas@@gmail.com>
53 @author Swisscom - http://www.swisscom.ch/
54 @author Christopher Michael <devilhorns@@comcast.net>
55 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
56 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
57 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
58 @author Brian Wang <brian.wang.0721@@gmail.com>
59 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
60 @author Samsung Electronics <tbd>
61 @author Samsung SAIT <tbd>
62 @author Brett Nash <nash@@nash.id.au>
63 @author Bruno Dilly <bdilly@@profusion.mobi>
64 @author Rafael Fonseca <rfonseca@@profusion.mobi>
65 @author Chuneon Park <hermet@@hermet.pe.kr>
66 @author Woohyun Jung <wh0705.jung@@samsung.com>
67 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
68 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
69 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
70 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
71 @author Gustavo Lima Chaves <glima@@profusion.mobi>
72 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
73 @author Tiago Falcão <tiago@@profusion.mobi>
74 @author Otavio Pontes <otavio@@profusion.mobi>
75 @author Viktor Kojouharov <vkojouharov@@gmail.com>
76 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
77 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
78 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
79 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
80 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
81 @author Jihoon Kim <jihoon48.kim@@samsung.com>
82 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
83 @author Tom Hacohen <tom@@stosb.com>
84 @author Aharon Hillel <a.hillel@@partner.samsung.com>
85 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
86 @author Shinwoo Kim <kimcinoo@@gmail.com>
87 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
88 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
89
90 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
91 contact with the developers and maintainers.
92  */
93
94 #ifndef ELEMENTARY_H
95 #define ELEMENTARY_H
96
97 /**
98  * @file Elementary.h
99  * @brief Elementary's API
100  *
101  * Elementary API.
102  */
103
104 @ELM_UNIX_DEF@ ELM_UNIX
105 @ELM_WIN32_DEF@ ELM_WIN32
106 @ELM_WINCE_DEF@ ELM_WINCE
107 @ELM_EDBUS_DEF@ ELM_EDBUS
108 @ELM_EFREET_DEF@ ELM_EFREET
109 @ELM_ETHUMB_DEF@ ELM_ETHUMB
110 @ELM_EMAP_DEF@ ELM_EMAP
111 @ELM_DEBUG_DEF@ ELM_DEBUG
112 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
113 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
114
115 /* Standard headers for standard system calls etc. */
116 #include <stdio.h>
117 #include <stdlib.h>
118 #include <unistd.h>
119 #include <string.h>
120 #include <sys/types.h>
121 #include <sys/stat.h>
122 #include <sys/time.h>
123 #include <sys/param.h>
124 #include <dlfcn.h>
125 #include <math.h>
126 #include <fnmatch.h>
127 #include <limits.h>
128 #include <ctype.h>
129 #include <time.h>
130 #include <dirent.h>
131 #include <pwd.h>
132 #include <errno.h>
133
134 #ifdef ELM_UNIX
135 # include <locale.h>
136 # ifdef ELM_LIBINTL_H
137 #  include <libintl.h>
138 # endif
139 # include <signal.h>
140 # include <grp.h>
141 # include <glob.h>
142 #endif
143
144 #ifdef ELM_ALLOCA_H
145 # include <alloca.h>
146 #endif
147
148 #if defined (ELM_WIN32) || defined (ELM_WINCE)
149 # include <malloc.h>
150 # ifndef alloca
151 #  define alloca _alloca
152 # endif
153 #endif
154
155
156 /* EFL headers */
157 #include <Eina.h>
158 #include <Eet.h>
159 #include <Evas.h>
160 #include <Evas_GL.h>
161 #include <Ecore.h>
162 #include <Ecore_Evas.h>
163 #include <Ecore_File.h>
164 #include <Ecore_IMF.h>
165 #include <Ecore_Con.h>
166 #include <Edje.h>
167
168 #ifdef ELM_EDBUS
169 # include <E_DBus.h>
170 #endif
171
172 #ifdef ELM_EFREET
173 # include <Efreet.h>
174 # include <Efreet_Mime.h>
175 # include <Efreet_Trash.h>
176 #endif
177
178 #ifdef ELM_ETHUMB
179 # include <Ethumb_Client.h>
180 #endif
181
182 #ifdef ELM_EMAP
183 # include <EMap.h>
184 #endif
185
186 #ifdef EAPI
187 # undef EAPI
188 #endif
189
190 #ifdef _WIN32
191 # ifdef ELEMENTARY_BUILD
192 #  ifdef DLL_EXPORT
193 #   define EAPI __declspec(dllexport)
194 #  else
195 #   define EAPI
196 #  endif /* ! DLL_EXPORT */
197 # else
198 #  define EAPI __declspec(dllimport)
199 # endif /* ! EFL_EVAS_BUILD */
200 #else
201 # ifdef __GNUC__
202 #  if __GNUC__ >= 4
203 #   define EAPI __attribute__ ((visibility("default")))
204 #  else
205 #   define EAPI
206 #  endif
207 # else
208 #  define EAPI
209 # endif
210 #endif /* ! _WIN32 */
211
212
213 /* allow usage from c++ */
214 #ifdef __cplusplus
215 extern "C" {
216 #endif
217
218 #define ELM_VERSION_MAJOR @VMAJ@
219 #define ELM_VERSION_MINOR @VMIN@
220
221    typedef struct _Elm_Version
222      {
223         int major;
224         int minor;
225         int micro;
226         int revision;
227      } Elm_Version;
228
229    EAPI extern Elm_Version *elm_version;
230
231 /* handy macros */
232 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
233 #define ELM_PI 3.14159265358979323846
234
235    /**
236     * @defgroup General General
237     *
238     * @brief General Elementary API. Functions that don't relate to
239     * Elementary objects specifically.
240     *
241     * Here are documented functions which init/shutdown the library,
242     * that apply to generic Elementary objects, that deal with
243     * configuration, et cetera.
244     *
245     * @ref general_functions_example_page "This" example contemplates
246     * some of these functions.
247     */
248
249    /**
250     * @addtogroup General
251     * @{
252     */
253
254   /**
255    * Defines couple of standard Evas_Object layers to be used
256    * with evas_object_layer_set().
257    *
258    * @note whenever extending with new values, try to keep some padding
259    *       to siblings so there is room for further extensions.
260    */
261   typedef enum _Elm_Object_Layer
262     {
263        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
264        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
265        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
266        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
267        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
268        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
269     } Elm_Object_Layer;
270
271 /**************************************************************************/
272    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
273
274    /**
275     * Emitted when any Elementary's policy value is changed.
276     */
277    EAPI extern int ELM_EVENT_POLICY_CHANGED;
278
279    /**
280     * @typedef Elm_Event_Policy_Changed
281     *
282     * Data on the event when an Elementary policy has changed
283     */
284     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
285
286    /**
287     * @struct _Elm_Event_Policy_Changed
288     *
289     * Data on the event when an Elementary policy has changed
290     */
291     struct _Elm_Event_Policy_Changed
292      {
293         unsigned int policy; /**< the policy identifier */
294         int          new_value; /**< value the policy had before the change */
295         int          old_value; /**< new value the policy got */
296     };
297
298    /**
299     * Policy identifiers.
300     */
301     typedef enum _Elm_Policy
302     {
303         ELM_POLICY_QUIT, /**< under which circunstances the application
304                           * should quit automatically. @see
305                           * Elm_Policy_Quit.
306                           */
307         ELM_POLICY_LAST
308     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
309  */
310
311    typedef enum _Elm_Policy_Quit
312      {
313         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
314                                    * automatically */
315         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
316                                             * application's last
317                                             * window is closed */
318      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
319
320    typedef enum _Elm_Focus_Direction
321      {
322         ELM_FOCUS_PREVIOUS,
323         ELM_FOCUS_NEXT,
324         ELM_FOCUS_UP,
325         ELM_FOCUS_DOWN,
326         ELM_FOCUS_LEFT,
327         ELM_FOCUS_RIGHT
328      } Elm_Focus_Direction;
329
330    typedef enum _Elm_Text_Format
331      {
332         ELM_TEXT_FORMAT_PLAIN_UTF8,
333         ELM_TEXT_FORMAT_MARKUP_UTF8
334      } Elm_Text_Format;
335
336    /**
337     * Line wrapping types.
338     */
339    typedef enum _Elm_Wrap_Type
340      {
341         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
342         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
343         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
344         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
345         ELM_WRAP_LAST
346      } Elm_Wrap_Type;
347
348    /**
349     * @typedef Elm_Object_Item
350     * An Elementary Object item handle.
351     * @ingroup General
352     */
353    typedef struct _Elm_Object_Item Elm_Object_Item;
354
355
356    /**
357     * Called back when a widget's tooltip is activated and needs content.
358     * @param data user-data given to elm_object_tooltip_content_cb_set()
359     * @param obj owner widget.
360     * @param tooltip The tooltip object (affix content to this!)
361     */
362    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
363
364    /**
365     * Called back when a widget's item tooltip is activated and needs content.
366     * @param data user-data given to elm_object_tooltip_content_cb_set()
367     * @param obj owner widget.
368     * @param tooltip The tooltip object (affix content to this!)
369     * @param item context dependent item. As an example, if tooltip was
370     *        set on Elm_List_Item, then it is of this type.
371     */
372    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
373
374    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
375
376 #ifndef ELM_LIB_QUICKLAUNCH
377 #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 */
378 #else
379 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
380 #endif
381
382 /**************************************************************************/
383    /* General calls */
384
385    /**
386     * Initialize Elementary
387     *
388     * @param[in] argc System's argument count value
389     * @param[in] argv System's pointer to array of argument strings
390     * @return The init counter value.
391     *
392     * This function initializes Elementary and increments a counter of
393     * the number of calls to it. It returs the new counter's value.
394     *
395     * @warning This call is exported only for use by the @c ELM_MAIN()
396     * macro. There is no need to use this if you use this macro (which
397     * is highly advisable). An elm_main() should contain the entry
398     * point code for your application, having the same prototype as
399     * elm_init(), and @b not being static (putting the @c EAPI symbol
400     * in front of its type declaration is advisable). The @c
401     * ELM_MAIN() call should be placed just after it.
402     *
403     * Example:
404     * @dontinclude bg_example_01.c
405     * @skip static void
406     * @until ELM_MAIN
407     *
408     * See the full @ref bg_example_01_c "example".
409     *
410     * @see elm_shutdown().
411     * @ingroup General
412     */
413    EAPI int          elm_init(int argc, char **argv);
414
415    /**
416     * Shut down Elementary
417     *
418     * @return The init counter value.
419     *
420     * This should be called at the end of your application, just
421     * before it ceases to do any more processing. This will clean up
422     * any permanent resources your application may have allocated via
423     * Elementary that would otherwise persist.
424     *
425     * @see elm_init() for an example
426     *
427     * @ingroup General
428     */
429    EAPI int          elm_shutdown(void);
430
431    /**
432     * Run Elementary's main loop
433     *
434     * This call should be issued just after all initialization is
435     * completed. This function will not return until elm_exit() is
436     * called. It will keep looping, running the main
437     * (event/processing) loop for Elementary.
438     *
439     * @see elm_init() for an example
440     *
441     * @ingroup General
442     */
443    EAPI void         elm_run(void);
444
445    /**
446     * Exit Elementary's main loop
447     *
448     * If this call is issued, it will flag the main loop to cease
449     * processing and return back to its parent function (usually your
450     * elm_main() function).
451     *
452     * @see elm_init() for an example. There, just after a request to
453     * close the window comes, the main loop will be left.
454     *
455     * @note By using the #ELM_POLICY_QUIT on your Elementary
456     * applications, you'll this function called automatically for you.
457     *
458     * @ingroup General
459     */
460    EAPI void         elm_exit(void);
461
462    /**
463     * Provide information in order to make Elementary determine the @b
464     * run time location of the software in question, so other data files
465     * such as images, sound files, executable utilities, libraries,
466     * modules and locale files can be found.
467     *
468     * @param mainfunc This is your application's main function name,
469     *        whose binary's location is to be found. Providing @c NULL
470     *        will make Elementary not to use it
471     * @param dom This will be used as the application's "domain", in the
472     *        form of a prefix to any environment variables that may
473     *        override prefix detection and the directory name, inside the
474     *        standard share or data directories, where the software's
475     *        data files will be looked for.
476     * @param checkfile This is an (optional) magic file's path to check
477     *        for existence (and it must be located in the data directory,
478     *        under the share directory provided above). Its presence will
479     *        help determine the prefix found was correct. Pass @c NULL if
480     *        the check is not to be done.
481     *
482     * This function allows one to re-locate the application somewhere
483     * else after compilation, if the developer wishes for easier
484     * distribution of pre-compiled binaries.
485     *
486     * The prefix system is designed to locate where the given software is
487     * installed (under a common path prefix) at run time and then report
488     * specific locations of this prefix and common directories inside
489     * this prefix like the binary, library, data and locale directories,
490     * through the @c elm_app_*_get() family of functions.
491     *
492     * Call elm_app_info_set() early on before you change working
493     * directory or anything about @c argv[0], so it gets accurate
494     * information.
495     *
496     * It will then try and trace back which file @p mainfunc comes from,
497     * if provided, to determine the application's prefix directory.
498     *
499     * The @p dom parameter provides a string prefix to prepend before
500     * environment variables, allowing a fallback to @b specific
501     * environment variables to locate the software. You would most
502     * probably provide a lowercase string there, because it will also
503     * serve as directory domain, explained next. For environment
504     * variables purposes, this string is made uppercase. For example if
505     * @c "myapp" is provided as the prefix, then the program would expect
506     * @c "MYAPP_PREFIX" as a master environment variable to specify the
507     * exact install prefix for the software, or more specific environment
508     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
509     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
510     * the user or scripts before launching. If not provided (@c NULL),
511     * environment variables will not be used to override compiled-in
512     * defaults or auto detections.
513     *
514     * The @p dom string also provides a subdirectory inside the system
515     * shared data directory for data files. For example, if the system
516     * directory is @c /usr/local/share, then this directory name is
517     * appended, creating @c /usr/local/share/myapp, if it @p was @c
518     * "myapp". It is expected the application installs data files in
519     * this directory.
520     *
521     * The @p checkfile is a file name or path of something inside the
522     * share or data directory to be used to test that the prefix
523     * detection worked. For example, your app will install a wallpaper
524     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
525     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
526     * checkfile string.
527     *
528     * @see elm_app_compile_bin_dir_set()
529     * @see elm_app_compile_lib_dir_set()
530     * @see elm_app_compile_data_dir_set()
531     * @see elm_app_compile_locale_set()
532     * @see elm_app_prefix_dir_get()
533     * @see elm_app_bin_dir_get()
534     * @see elm_app_lib_dir_get()
535     * @see elm_app_data_dir_get()
536     * @see elm_app_locale_dir_get()
537     */
538    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
539
540    /**
541     * Provide information on the @b fallback application's binaries
542     * directory, on scenarios where they get overriden by
543     * elm_app_info_set().
544     *
545     * @param dir The path to the default binaries directory (compile time
546     * one)
547     *
548     * @note Elementary will as well use this path to determine actual
549     * names of binaries' directory paths, maybe changing it to be @c
550     * something/local/bin instead of @c something/bin, only, for
551     * example.
552     *
553     * @warning You should call this function @b before
554     * elm_app_info_set().
555     */
556    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
557
558    /**
559     * Provide information on the @b fallback application's libraries
560     * directory, on scenarios where they get overriden by
561     * elm_app_info_set().
562     *
563     * @param dir The path to the default libraries directory (compile
564     * time one)
565     *
566     * @note Elementary will as well use this path to determine actual
567     * names of libraries' directory paths, maybe changing it to be @c
568     * something/lib32 or @c something/lib64 instead of @c something/lib,
569     * only, for example.
570     *
571     * @warning You should call this function @b before
572     * elm_app_info_set().
573     */
574    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
575
576    /**
577     * Provide information on the @b fallback application's data
578     * directory, on scenarios where they get overriden by
579     * elm_app_info_set().
580     *
581     * @param dir The path to the default data directory (compile time
582     * one)
583     *
584     * @note Elementary will as well use this path to determine actual
585     * names of data directory paths, maybe changing it to be @c
586     * something/local/share instead of @c something/share, only, for
587     * example.
588     *
589     * @warning You should call this function @b before
590     * elm_app_info_set().
591     */
592    EAPI void         elm_app_compile_data_dir_set(const char *dir);
593
594    /**
595     * Provide information on the @b fallback application's locale
596     * directory, on scenarios where they get overriden by
597     * elm_app_info_set().
598     *
599     * @param dir The path to the default locale directory (compile time
600     * one)
601     *
602     * @warning You should call this function @b before
603     * elm_app_info_set().
604     */
605    EAPI void         elm_app_compile_locale_set(const char *dir);
606
607    /**
608     * Retrieve the application's run time prefix directory, as set by
609     * elm_app_info_set() and the way (environment) the application was
610     * run from.
611     *
612     * @return The directory prefix the application is actually using
613     */
614    EAPI const char  *elm_app_prefix_dir_get(void);
615
616    /**
617     * Retrieve the application's run time binaries prefix directory, as
618     * set by elm_app_info_set() and the way (environment) the application
619     * was run from.
620     *
621     * @return The binaries directory prefix the application is actually
622     * using
623     */
624    EAPI const char  *elm_app_bin_dir_get(void);
625
626    /**
627     * Retrieve the application's run time libraries prefix directory, as
628     * set by elm_app_info_set() and the way (environment) the application
629     * was run from.
630     *
631     * @return The libraries directory prefix the application is actually
632     * using
633     */
634    EAPI const char  *elm_app_lib_dir_get(void);
635
636    /**
637     * Retrieve the application's run time data prefix directory, as
638     * set by elm_app_info_set() and the way (environment) the application
639     * was run from.
640     *
641     * @return The data directory prefix the application is actually
642     * using
643     */
644    EAPI const char  *elm_app_data_dir_get(void);
645
646    /**
647     * Retrieve the application's run time locale prefix directory, as
648     * set by elm_app_info_set() and the way (environment) the application
649     * was run from.
650     *
651     * @return The locale directory prefix the application is actually
652     * using
653     */
654    EAPI const char  *elm_app_locale_dir_get(void);
655
656    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
657    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
658    EAPI int          elm_quicklaunch_init(int argc, char **argv);
659    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
660    EAPI int          elm_quicklaunch_sub_shutdown(void);
661    EAPI int          elm_quicklaunch_shutdown(void);
662    EAPI void         elm_quicklaunch_seed(void);
663    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
664    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
665    EAPI void         elm_quicklaunch_cleanup(void);
666    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
667    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
668
669    EAPI Eina_Bool    elm_need_efreet(void);
670    EAPI Eina_Bool    elm_need_e_dbus(void);
671    EAPI Eina_Bool    elm_need_ethumb(void);
672
673    /**
674     * Set a new policy's value (for a given policy group/identifier).
675     *
676     * @param policy policy identifier, as in @ref Elm_Policy.
677     * @param value policy value, which depends on the identifier
678     *
679     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
680     *
681     * Elementary policies define applications' behavior,
682     * somehow. These behaviors are divided in policy groups (see
683     * #Elm_Policy enumeration). This call will emit the Ecore event
684     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
685     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
686     * then.
687     *
688     * @note Currently, we have only one policy identifier/group
689     * (#ELM_POLICY_QUIT), which has two possible values.
690     *
691     * @ingroup General
692     */
693    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
694
695    /**
696     * Gets the policy value set for given policy identifier.
697     *
698     * @param policy policy identifier, as in #Elm_Policy.
699     * @return The currently set policy value, for that
700     * identifier. Will be @c 0 if @p policy passed is invalid.
701     *
702     * @ingroup General
703     */
704    EAPI int          elm_policy_get(unsigned int policy);
705
706    /**
707     * Set a label of an object
708     *
709     * @param obj The Elementary object
710     * @param part The text part name to set (NULL for the default label)
711     * @param label The new text of the label
712     *
713     * @note Elementary objects may have many labels (e.g. Action Slider)
714     *
715     * @ingroup General
716     */
717    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
718
719 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
720
721    /**
722     * Get a label of an object
723     *
724     * @param obj The Elementary object
725     * @param part The text part name to get (NULL for the default label)
726     * @return text of the label or NULL for any error
727     *
728     * @note Elementary objects may have many labels (e.g. Action Slider)
729     *
730     * @ingroup General
731     */
732    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
733
734 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
735
736    /**
737     * Set a content of an object
738     *
739     * @param obj The Elementary object
740     * @param part The content part name to set (NULL for the default content)
741     * @param content The new content of the object
742     *
743     * @note Elementary objects may have many contents
744     *
745     * @ingroup General
746     */
747    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
748
749 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
750
751    /**
752     * Get a content of an object
753     *
754     * @param obj The Elementary object
755     * @param item The content part name to get (NULL for the default content)
756     * @return content of the object or NULL for any error
757     *
758     * @note Elementary objects may have many contents
759     *
760     * @ingroup General
761     */
762    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
763
764 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
765
766    /**
767     * Unset a content of an object
768     *
769     * @param obj The Elementary object
770     * @param item The content part name to unset (NULL for the default content)
771     *
772     * @note Elementary objects may have many contents
773     *
774     * @ingroup General
775     */
776    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
777
778 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
779
780    /**
781     * Set a content of an object item
782     *
783     * @param it The Elementary object item
784     * @param part The content part name to unset (NULL for the default content)
785     * @param content The new content of the object item
786     *
787     * @note Elementary object items may have many contents
788     *
789     * @ingroup General
790     */
791    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
792
793 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
794
795    /**
796     * Get a content of an object item
797     *
798     * @param it The Elementary object item
799     * @param part The content part name to unset (NULL for the default content)
800     * @return content of the object item or NULL for any error
801     *
802     * @note Elementary object items may have many contents
803     *
804     * @ingroup General
805     */
806    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
807
808 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
809
810    /**
811     * Unset a content of an object item
812     *
813     * @param it The Elementary object item
814     * @param part The content part name to unset (NULL for the default content)
815     *
816     * @note Elementary object items may have many contents
817     *
818     * @ingroup General
819     */
820    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
821
822 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
823
824    /**
825     * Set a label of an objec itemt
826     *
827     * @param it The Elementary object item
828     * @param part The text part name to set (NULL for the default label)
829     * @param label The new text of the label
830     *
831     * @note Elementary object items may have many labels
832     *
833     * @ingroup General
834     */
835    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
836
837 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
838
839    /**
840     * Get a label of an object
841     *
842     * @param it The Elementary object item
843     * @param part The text part name to get (NULL for the default label)
844     * @return text of the label or NULL for any error
845     *
846     * @note Elementary object items may have many labels
847     *
848     * @ingroup General
849     */
850    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
851
852 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
853
854    /**
855     * @}
856     */
857
858    EAPI void         elm_all_flush(void);
859    EAPI int          elm_cache_flush_interval_get(void);
860    EAPI void         elm_cache_flush_interval_set(int size);
861    EAPI void         elm_cache_flush_interval_all_set(int size);
862    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
863    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
864    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
865    EAPI int          elm_font_cache_get(void);
866    EAPI void         elm_font_cache_set(int size);
867    EAPI void         elm_font_cache_all_set(int size);
868    EAPI int          elm_image_cache_get(void);
869    EAPI void         elm_image_cache_set(int size);
870    EAPI void         elm_image_cache_all_set(int size);
871    EAPI int          elm_edje_file_cache_get(void);
872    EAPI void         elm_edje_file_cache_set(int size);
873    EAPI void         elm_edje_file_cache_all_set(int size);
874    EAPI int          elm_edje_collection_cache_get(void);
875    EAPI void         elm_edje_collection_cache_set(int size);
876    EAPI void         elm_edje_collection_cache_all_set(int size);
877
878    /**
879     * @defgroup Scaling Selective Widget Scaling
880     *
881     * Different widgets can be scaled independently. These functions
882     * allow you to manipulate this scaling on a per-widget basis. The
883     * object and all its children get their scaling factors multiplied
884     * by the scale factor set. This is multiplicative, in that if a
885     * child also has a scale size set it is in turn multiplied by its
886     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
887     * double size, @c 0.5 is half, etc.
888     *
889     * @ref general_functions_example_page "This" example contemplates
890     * some of these functions.
891     */
892
893    /**
894     * Set the scaling factor for a given Elementary object
895     *
896     * @param obj The Elementary to operate on
897     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
898     * no scaling)
899     *
900     * @ingroup Scaling
901     */
902    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
903
904    /**
905     * Get the scaling factor for a given Elementary object
906     *
907     * @param obj The object
908     * @return The scaling factor set by elm_object_scale_set()
909     *
910     * @ingroup Scaling
911     */
912    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
913    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
914    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
915    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
916    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
917    /**
918     * Set the style to use by a widget
919     *
920     * Sets the style name that will define the appearance of a widget. Styles
921     * vary from widget to widget and may also be defined by other themes
922     * by means of extensions and overlays.
923     *
924     * @param obj The Elementary widget to style
925     * @param style The style name to use
926     *
927     * @see elm_theme_extension_add()
928     * @see elm_theme_overlay_add()
929     *
930     * @ingroup Theme
931     */
932    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
933    /**
934     * Get the style used by the widget
935     *
936     * This gets the style being used for that widget. Note that the string
937     * pointer is only valid as longas the object is valid and the style doesn't
938     * change.
939     *
940     * @param obj The Elementary widget to query for its style
941     * @return The style name used
942     *
943     * @see elm_object_style_set()
944     *
945     * @ingroup Theme
946     */
947    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
948
949    /**
950     * @defgroup Styles Styles
951     *
952     * Widgets can have different styles of look. These generic API's
953     * set styles of widgets, if they support them (and if the theme(s)
954     * do).
955     *
956     * @ref general_functions_example_page "This" example contemplates
957     * some of these functions.
958     */
959
960    /**
961     * Set the disabled state of an Elementary object.
962     *
963     * @param obj The Elementary object to operate on
964     * @param disabled The state to put in in: @c EINA_TRUE for
965     *        disabled, @c EINA_FALSE for enabled
966     *
967     * Elementary objects can be @b disabled, in which state they won't
968     * receive input and, in general, will be themed differently from
969     * their normal state, usually greyed out. Useful for contexts
970     * where you don't want your users to interact with some of the
971     * parts of you interface.
972     *
973     * This sets the state for the widget, either disabling it or
974     * enabling it back.
975     *
976     * @ingroup Styles
977     */
978    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
979
980    /**
981     * Get the disabled state of an Elementary object.
982     *
983     * @param obj The Elementary object to operate on
984     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
985     *            if it's enabled (or on errors)
986     *
987     * This gets the state of the widget, which might be enabled or disabled.
988     *
989     * @ingroup Styles
990     */
991    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
992
993    /**
994     * @defgroup WidgetNavigation Widget Tree Navigation.
995     *
996     * How to check if an Evas Object is an Elementary widget? How to
997     * get the first elementary widget that is parent of the given
998     * object?  These are all covered in widget tree navigation.
999     *
1000     * @ref general_functions_example_page "This" example contemplates
1001     * some of these functions.
1002     */
1003
1004    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1005
1006    /**
1007     * Get the first parent of the given object that is an Elementary
1008     * widget.
1009     *
1010     * @param obj the Elementary object to query parent from.
1011     * @return the parent object that is an Elementary widget, or @c
1012     *         NULL, if it was not found.
1013     *
1014     * Use this to query for an object's parent widget.
1015     *
1016     * @note Most of Elementary users wouldn't be mixing non-Elementary
1017     * smart objects in the objects tree of an application, as this is
1018     * an advanced usage of Elementary with Evas. So, except for the
1019     * application's window, which is the root of that tree, all other
1020     * objects would have valid Elementary widget parents.
1021     *
1022     * @ingroup WidgetNavigation
1023     */
1024    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1025    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1026    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1027
1028    EAPI double       elm_scale_get(void);
1029    EAPI void         elm_scale_set(double scale);
1030    EAPI void         elm_scale_all_set(double scale);
1031
1032    EAPI Eina_Bool    elm_mirrored_get(void);
1033    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1034
1035    EAPI Eina_Bool    elm_config_save(void);
1036    EAPI void         elm_config_reload(void);
1037
1038    EAPI const char  *elm_profile_current_get(void);
1039    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1040    EAPI void         elm_profile_dir_free(const char *p_dir);
1041    EAPI Eina_List   *elm_profile_list_get(void);
1042    EAPI void         elm_profile_list_free(Eina_List *l);
1043    EAPI void         elm_profile_set(const char *profile);
1044    EAPI void         elm_profile_all_set(const char *profile);
1045
1046    EAPI const char  *elm_engine_current_get(void);
1047    EAPI void         elm_engine_set(const char *engine);
1048
1049   typedef struct _Elm_Text_Class
1050     {
1051        const char *name;
1052        const char *desc;
1053     } Elm_Text_Class;
1054
1055   typedef struct _Elm_Font_Overlay
1056     {
1057        const char     *text_class;
1058        const char     *font;
1059        Evas_Font_Size  size;
1060     } Elm_Font_Overlay;
1061
1062   typedef struct _Elm_Font_Properties
1063     {
1064        const char *name;
1065        Eina_List  *styles;
1066     } Elm_Font_Properties;
1067
1068    EAPI const Eina_List     *elm_text_classes_list_get(void);
1069    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1070
1071    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1072    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1073    EAPI void                 elm_font_overlay_unset(const char *text_class);
1074    EAPI void                 elm_font_overlay_apply(void);
1075    EAPI void                 elm_font_overlay_all_apply(void);
1076
1077    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1078    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1079    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1080    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1081    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
1082    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
1083
1084    /**
1085     * @defgroup Fingers Fingers
1086     *
1087     * Elementary is designed to be finger-friendly for touchscreens,
1088     * and so in addition to scaling for display resolution, it can
1089     * also scale based on finger "resolution" (or size). You can then
1090     * customize the granularity of the areas meant to receive clicks
1091     * on touchscreens.
1092     *
1093     * Different profiles may have pre-set values for finger sizes.
1094     *
1095     * @ref general_functions_example_page "This" example contemplates
1096     * some of these functions.
1097     */
1098
1099    /**
1100     * Get the configured "finger size"
1101     *
1102     * @return The finger size
1103     *
1104     * This gets the globally configured finger size, <b>in pixels</b>
1105     *
1106     * @ingroup Fingers
1107     */
1108    EAPI Evas_Coord       elm_finger_size_get(void);
1109    EAPI void             elm_finger_size_set(Evas_Coord size);
1110    EAPI void             elm_finger_size_all_set(Evas_Coord size);
1111
1112    /**
1113     * @defgroup Focus Focus
1114     *
1115     * An Elementary application has, at all times, one (and only one)
1116     * @b focused object. This is what determines where the input
1117     * events go to within the application's window. Also, focused
1118     * objects can be decorated differently, in order to signal to the
1119     * user where the input is, at a given moment.
1120     *
1121     * Elementary applications also have the concept of <b>focus
1122     * chain</b>: one can cycle through all the windows' focusable
1123     * objects by input (tab key) or programmatically. The default
1124     * focus chain for an application is the one define by the order in
1125     * which the widgets where added in code. One will cycle through
1126     * top level widgets, and, for each one containg sub-objects, cycle
1127     * through them all, before returning to the level
1128     * above. Elementary also allows one to set @b custom focus chains
1129     * for their applications.
1130     *
1131     * Besides the focused decoration a widget may exhibit, when it
1132     * gets focus, Elementary has a @b global focus highlight object
1133     * that can be enabled for a window. If one chooses to do so, this
1134     * extra highlight effect will surround the current focused object,
1135     * too.
1136     *
1137     * @note Some Elementary widgets are @b unfocusable, after
1138     * creation, by their very nature: they are not meant to be
1139     * interacted with input events, but are there just for visual
1140     * purposes.
1141     *
1142     * @ref general_functions_example_page "This" example contemplates
1143     * some of these functions.
1144     */
1145
1146    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
1147    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
1148    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
1149    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
1150
1151    /**
1152     * Get the whether an Elementary object has the focus or not.
1153     *
1154     * @param obj The Elementary object to get the information from
1155     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1156     *            not (and on errors).
1157     *
1158     * @see elm_object_focus()
1159     *
1160     * @ingroup Focus
1161     */
1162    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1163
1164    /**
1165     * Set/unset focus to a given Elementary object.
1166     *
1167     * @param obj The Elementary object to operate on.
1168     * @param enable @c EINA_TRUE Set focus to a given object,
1169     *               @c EINA_FALSE Unset focus to a given object.
1170     *
1171     * @note When you set focus to this object, if it can handle focus, will
1172     * take the focus away from the one who had it previously and will, for
1173     * now on, be the one receiving input events. Unsetting focus will remove
1174     * the focus from @p obj, passing it back to the previous element in the
1175     * focus chain list.
1176     *
1177     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1178     *
1179     * @ingroup Focus
1180     */
1181    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1182
1183    /**
1184     * Make a given Elementary object the focused one.
1185     *
1186     * @param obj The Elementary object to make focused.
1187     *
1188     * @note This object, if it can handle focus, will take the focus
1189     * away from the one who had it previously and will, for now on, be
1190     * the one receiving input events.
1191     *
1192     * @see elm_object_focus_get()
1193     * @deprecated use elm_object_focus_set() instead.
1194     *
1195     * @ingroup Focus
1196     */
1197    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1198
1199    /**
1200     * Remove the focus from an Elementary object
1201     *
1202     * @param obj The Elementary to take focus from
1203     *
1204     * This removes the focus from @p obj, passing it back to the
1205     * previous element in the focus chain list.
1206     *
1207     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1208     * @deprecated use elm_object_focus_set() instead.
1209     *
1210     * @ingroup Focus
1211     */
1212    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1213
1214    /**
1215     * Set the ability for an Element object to be focused
1216     *
1217     * @param obj The Elementary object to operate on
1218     * @param enable @c EINA_TRUE if the object can be focused, @c
1219     *        EINA_FALSE if not (and on errors)
1220     *
1221     * This sets whether the object @p obj is able to take focus or
1222     * not. Unfocusable objects do nothing when programmatically
1223     * focused, being the nearest focusable parent object the one
1224     * really getting focus. Also, when they receive mouse input, they
1225     * will get the event, but not take away the focus from where it
1226     * was previously.
1227     *
1228     * @ingroup Focus
1229     */
1230    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1231
1232    /**
1233     * Get whether an Elementary object is focusable or not
1234     *
1235     * @param obj The Elementary object to operate on
1236     * @return @c EINA_TRUE if the object is allowed to be focused, @c
1237     *             EINA_FALSE if not (and on errors)
1238     *
1239     * @note Objects which are meant to be interacted with by input
1240     * events are created able to be focused, by default. All the
1241     * others are not.
1242     *
1243     * @ingroup Focus
1244     */
1245    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1246
1247    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1248    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1249    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1250    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1251    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1252    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1253    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1254
1255    /**
1256     * Make the elementary object and its children to be unfocusable (or focusable).
1257     *
1258     * @param obj The Elementary object to operate on
1259     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1260     *        @c EINA_FALSE for focusable.
1261     *
1262     * This sets whether the object @p obj and its children objects
1263     * are able to take focus or not. If the tree is set as unfocusable,
1264     * newest focused object which is not in this tree will get focus.
1265     * This API can be helpful for an object to be deleted.
1266     * When an object will be deleted soon, it and its children may not
1267     * want to get focus (by focus reverting or by other focus controls).
1268     * Then, just use this API before deleting.
1269     *
1270     * @see elm_object_tree_unfocusable_get()
1271     *
1272     * @ingroup Focus
1273     */
1274    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1275
1276    /**
1277     * Get whether an Elementary object and its children are unfocusable or not.
1278     *
1279     * @param obj The Elementary object to get the information from
1280     * @return @c EINA_TRUE, if the tree is unfocussable,
1281     *         @c EINA_FALSE if not (and on errors).
1282     *
1283     * @see elm_object_tree_unfocusable_set()
1284     *
1285     * @ingroup Focus
1286     */
1287    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1288
1289    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
1290    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1291    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1292    EAPI double           elm_scroll_bounce_friction_get(void);
1293    EAPI void             elm_scroll_bounce_friction_set(double friction);
1294    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
1295    EAPI double           elm_scroll_page_scroll_friction_get(void);
1296    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
1297    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
1298    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
1299    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
1300    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
1301    EAPI double           elm_scroll_zoom_friction_get(void);
1302    EAPI void             elm_scroll_zoom_friction_set(double friction);
1303    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
1304    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
1305    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1306    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1307    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
1308    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1309    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1310    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
1311    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1312    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1313    EAPI double           elm_scroll_thumbscroll_friction_get(void);
1314    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
1315    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
1316    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
1317    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
1318    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
1319
1320    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1321    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1322    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1323    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1324    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1325    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1326    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1327    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1328
1329    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1330    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);
1331    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);
1332
1333    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1334    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1335
1336    /**
1337     * Adjust size of an element for finger usage.
1338     *
1339     * @param times_w How many fingers should fit horizontally
1340     * @param w Pointer to the width size to adjust
1341     * @param times_h How many fingers should fit vertically
1342     * @param h Pointer to the height size to adjust
1343     *
1344     * This takes width and height sizes (in pixels) as input and a
1345     * size multiple (which is how many fingers you want to place
1346     * within the area, being "finger" the size set by
1347     * elm_finger_size_set()), and adjusts the size to be large enough
1348     * to accommodate the resulting size -- if it doesn't already
1349     * accommodate it. On return the @p w and @p h sizes pointed to by
1350     * these parameters will be modified, on those conditions.
1351     *
1352     * @note This is kind of a low level Elementary call, most useful
1353     * on size evaluation times for widgets. An external user wouldn't
1354     * be calling, most of the time.
1355     *
1356     * @ingroup Fingers
1357     */
1358    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1359
1360    EAPI double           elm_longpress_timeout_get(void);
1361    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
1362
1363    /* debug
1364     * don't use it unless you are sure
1365     */
1366    EAPI void             elm_object_tree_dump(const Evas_Object *top);
1367    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1368
1369
1370    /* theme */
1371    /**
1372     * @defgroup Theme Theme
1373     *
1374     * Elementary uses Edje to theme its widgets, naturally. But for the most
1375     * part this is hidden behind a simpler interface that lets the user set
1376     * extensions and choose the style of widgets in a much easier way.
1377     *
1378     * Instead of thinking in terms of paths to Edje files and their groups
1379     * each time you want to change the appearance of a widget, Elementary
1380     * works so you can add any theme file with extensions or replace the
1381     * main theme at one point in the application, and then just set the style
1382     * of widgets with elm_object_style_set() and related functions. Elementary
1383     * will then look in its list of themes for a matching group and apply it,
1384     * and when the theme changes midway through the application, all widgets
1385     * will be updated accordingly.
1386     *
1387     * There are three concepts you need to know to understand how Elementary
1388     * theming works: default theme, extensions and overlays.
1389     *
1390     * Default theme, obviously enough, is the one that provides the default
1391     * look of all widgets. End users can change the theme used by Elementary
1392     * by setting the @c ELM_THEME environment variable before running an
1393     * application, or globally for all programs using the @c elementary_config
1394     * utility. Applications can change the default theme using elm_theme_set(),
1395     * but this can go against the user wishes, so it's not an adviced practice.
1396     *
1397     * Ideally, applications should find everything they need in the already
1398     * provided theme, but there may be occasions when that's not enough and
1399     * custom styles are required to correctly express the idea. For this
1400     * cases, Elementary has extensions.
1401     *
1402     * Extensions allow the application developer to write styles of its own
1403     * to apply to some widgets. This requires knowledge of how each widget
1404     * is themed, as extensions will always replace the entire group used by
1405     * the widget, so important signals and parts need to be there for the
1406     * object to behave properly (see documentation of Edje for details).
1407     * Once the theme for the extension is done, the application needs to add
1408     * it to the list of themes Elementary will look into, using
1409     * elm_theme_extension_add(), and set the style of the desired widgets as
1410     * he would normally with elm_object_style_set().
1411     *
1412     * Overlays, on the other hand, can replace the look of all widgets by
1413     * overriding the default style. Like extensions, it's up to the application
1414     * developer to write the theme for the widgets it wants, the difference
1415     * being that when looking for the theme, Elementary will check first the
1416     * list of overlays, then the set theme and lastly the list of extensions,
1417     * so with overlays it's possible to replace the default view and every
1418     * widget will be affected. This is very much alike to setting the whole
1419     * theme for the application and will probably clash with the end user
1420     * options, not to mention the risk of ending up with not matching styles
1421     * across the program. Unless there's a very special reason to use them,
1422     * overlays should be avoided for the resons exposed before.
1423     *
1424     * All these theme lists are handled by ::Elm_Theme instances. Elementary
1425     * keeps one default internally and every function that receives one of
1426     * these can be called with NULL to refer to this default (except for
1427     * elm_theme_free()). It's possible to create a new instance of a
1428     * ::Elm_Theme to set other theme for a specific widget (and all of its
1429     * children), but this is as discouraged, if not even more so, than using
1430     * overlays. Don't use this unless you really know what you are doing.
1431     *
1432     * But to be less negative about things, you can look at the following
1433     * examples:
1434     * @li @ref theme_example_01 "Using extensions"
1435     * @li @ref theme_example_02 "Using overlays"
1436     *
1437     * @{
1438     */
1439    /**
1440     * @typedef Elm_Theme
1441     *
1442     * Opaque handler for the list of themes Elementary looks for when
1443     * rendering widgets.
1444     *
1445     * Stay out of this unless you really know what you are doing. For most
1446     * cases, sticking to the default is all a developer needs.
1447     */
1448    typedef struct _Elm_Theme Elm_Theme;
1449
1450    /**
1451     * Create a new specific theme
1452     *
1453     * This creates an empty specific theme that only uses the default theme. A
1454     * specific theme has its own private set of extensions and overlays too
1455     * (which are empty by default). Specific themes do not fall back to themes
1456     * of parent objects. They are not intended for this use. Use styles, overlays
1457     * and extensions when needed, but avoid specific themes unless there is no
1458     * other way (example: you want to have a preview of a new theme you are
1459     * selecting in a "theme selector" window. The preview is inside a scroller
1460     * and should display what the theme you selected will look like, but not
1461     * actually apply it yet. The child of the scroller will have a specific
1462     * theme set to show this preview before the user decides to apply it to all
1463     * applications).
1464     */
1465    EAPI Elm_Theme       *elm_theme_new(void);
1466    /**
1467     * Free a specific theme
1468     *
1469     * @param th The theme to free
1470     *
1471     * This frees a theme created with elm_theme_new().
1472     */
1473    EAPI void             elm_theme_free(Elm_Theme *th);
1474    /**
1475     * Copy the theme fom the source to the destination theme
1476     *
1477     * @param th The source theme to copy from
1478     * @param thdst The destination theme to copy data to
1479     *
1480     * This makes a one-time static copy of all the theme config, extensions
1481     * and overlays from @p th to @p thdst. If @p th references a theme, then
1482     * @p thdst is also set to reference it, with all the theme settings,
1483     * overlays and extensions that @p th had.
1484     */
1485    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1486    /**
1487     * Tell the source theme to reference the ref theme
1488     *
1489     * @param th The theme that will do the referencing
1490     * @param thref The theme that is the reference source
1491     *
1492     * This clears @p th to be empty and then sets it to refer to @p thref
1493     * so @p th acts as an override to @p thref, but where its overrides
1494     * don't apply, it will fall through to @p thref for configuration.
1495     */
1496    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1497    /**
1498     * Return the theme referred to
1499     *
1500     * @param th The theme to get the reference from
1501     * @return The referenced theme handle
1502     *
1503     * This gets the theme set as the reference theme by elm_theme_ref_set().
1504     * If no theme is set as a reference, NULL is returned.
1505     */
1506    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
1507    /**
1508     * Return the default theme
1509     *
1510     * @return The default theme handle
1511     *
1512     * This returns the internal default theme setup handle that all widgets
1513     * use implicitly unless a specific theme is set. This is also often use
1514     * as a shorthand of NULL.
1515     */
1516    EAPI Elm_Theme       *elm_theme_default_get(void);
1517    /**
1518     * Prepends a theme overlay to the list of overlays
1519     *
1520     * @param th The theme to add to, or if NULL, the default theme
1521     * @param item The Edje file path to be used
1522     *
1523     * Use this if your application needs to provide some custom overlay theme
1524     * (An Edje file that replaces some default styles of widgets) where adding
1525     * new styles, or changing system theme configuration is not possible. Do
1526     * NOT use this instead of a proper system theme configuration. Use proper
1527     * configuration files, profiles, environment variables etc. to set a theme
1528     * so that the theme can be altered by simple confiugration by a user. Using
1529     * this call to achieve that effect is abusing the API and will create lots
1530     * of trouble.
1531     *
1532     * @see elm_theme_extension_add()
1533     */
1534    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
1535    /**
1536     * Delete a theme overlay from the list of overlays
1537     *
1538     * @param th The theme to delete from, or if NULL, the default theme
1539     * @param item The name of the theme overlay
1540     *
1541     * @see elm_theme_overlay_add()
1542     */
1543    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
1544    /**
1545     * Appends a theme extension to the list of extensions.
1546     *
1547     * @param th The theme to add to, or if NULL, the default theme
1548     * @param item The Edje file path to be used
1549     *
1550     * This is intended when an application needs more styles of widgets or new
1551     * widget themes that the default does not provide (or may not provide). The
1552     * application has "extended" usage by coming up with new custom style names
1553     * for widgets for specific uses, but as these are not "standard", they are
1554     * not guaranteed to be provided by a default theme. This means the
1555     * application is required to provide these extra elements itself in specific
1556     * Edje files. This call adds one of those Edje files to the theme search
1557     * path to be search after the default theme. The use of this call is
1558     * encouraged when default styles do not meet the needs of the application.
1559     * Use this call instead of elm_theme_overlay_add() for almost all cases.
1560     *
1561     * @see elm_object_style_set()
1562     */
1563    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
1564    /**
1565     * Deletes a theme extension from the list of extensions.
1566     *
1567     * @param th The theme to delete from, or if NULL, the default theme
1568     * @param item The name of the theme extension
1569     *
1570     * @see elm_theme_extension_add()
1571     */
1572    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
1573    /**
1574     * Set the theme search order for the given theme
1575     *
1576     * @param th The theme to set the search order, or if NULL, the default theme
1577     * @param theme Theme search string
1578     *
1579     * This sets the search string for the theme in path-notation from first
1580     * theme to search, to last, delimited by the : character. Example:
1581     *
1582     * "shiny:/path/to/file.edj:default"
1583     *
1584     * See the ELM_THEME environment variable for more information.
1585     *
1586     * @see elm_theme_get()
1587     * @see elm_theme_list_get()
1588     */
1589    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
1590    /**
1591     * Return the theme search order
1592     *
1593     * @param th The theme to get the search order, or if NULL, the default theme
1594     * @return The internal search order path
1595     *
1596     * This function returns a colon separated string of theme elements as
1597     * returned by elm_theme_list_get().
1598     *
1599     * @see elm_theme_set()
1600     * @see elm_theme_list_get()
1601     */
1602    EAPI const char      *elm_theme_get(Elm_Theme *th);
1603    /**
1604     * Return a list of theme elements to be used in a theme.
1605     *
1606     * @param th Theme to get the list of theme elements from.
1607     * @return The internal list of theme elements
1608     *
1609     * This returns the internal list of theme elements (will only be valid as
1610     * long as the theme is not modified by elm_theme_set() or theme is not
1611     * freed by elm_theme_free(). This is a list of strings which must not be
1612     * altered as they are also internal. If @p th is NULL, then the default
1613     * theme element list is returned.
1614     *
1615     * A theme element can consist of a full or relative path to a .edj file,
1616     * or a name, without extension, for a theme to be searched in the known
1617     * theme paths for Elemementary.
1618     *
1619     * @see elm_theme_set()
1620     * @see elm_theme_get()
1621     */
1622    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1623    /**
1624     * Return the full patrh for a theme element
1625     *
1626     * @param f The theme element name
1627     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1628     * @return The full path to the file found.
1629     *
1630     * This returns a string you should free with free() on success, NULL on
1631     * failure. This will search for the given theme element, and if it is a
1632     * full or relative path element or a simple searchable name. The returned
1633     * path is the full path to the file, if searched, and the file exists, or it
1634     * is simply the full path given in the element or a resolved path if
1635     * relative to home. The @p in_search_path boolean pointed to is set to
1636     * EINA_TRUE if the file was a searchable file andis in the search path,
1637     * and EINA_FALSE otherwise.
1638     */
1639    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1640    /**
1641     * Flush the current theme.
1642     *
1643     * @param th Theme to flush
1644     *
1645     * This flushes caches that let elementary know where to find theme elements
1646     * in the given theme. If @p th is NULL, then the default theme is flushed.
1647     * Call this function if source theme data has changed in such a way as to
1648     * make any caches Elementary kept invalid.
1649     */
1650    EAPI void             elm_theme_flush(Elm_Theme *th);
1651    /**
1652     * This flushes all themes (default and specific ones).
1653     *
1654     * This will flush all themes in the current application context, by calling
1655     * elm_theme_flush() on each of them.
1656     */
1657    EAPI void             elm_theme_full_flush(void);
1658    /**
1659     * Set the theme for all elementary using applications on the current display
1660     *
1661     * @param theme The name of the theme to use. Format same as the ELM_THEME
1662     * environment variable.
1663     */
1664    EAPI void             elm_theme_all_set(const char *theme);
1665    /**
1666     * Return a list of theme elements in the theme search path
1667     *
1668     * @return A list of strings that are the theme element names.
1669     *
1670     * This lists all available theme files in the standard Elementary search path
1671     * for theme elements, and returns them in alphabetical order as theme
1672     * element names in a list of strings. Free this with
1673     * elm_theme_name_available_list_free() when you are done with the list.
1674     */
1675    EAPI Eina_List       *elm_theme_name_available_list_new(void);
1676    /**
1677     * Free the list returned by elm_theme_name_available_list_new()
1678     *
1679     * This frees the list of themes returned by
1680     * elm_theme_name_available_list_new(). Once freed the list should no longer
1681     * be used. a new list mys be created.
1682     */
1683    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
1684    /**
1685     * Set a specific theme to be used for this object and its children
1686     *
1687     * @param obj The object to set the theme on
1688     * @param th The theme to set
1689     *
1690     * This sets a specific theme that will be used for the given object and any
1691     * child objects it has. If @p th is NULL then the theme to be used is
1692     * cleared and the object will inherit its theme from its parent (which
1693     * ultimately will use the default theme if no specific themes are set).
1694     *
1695     * Use special themes with great care as this will annoy users and make
1696     * configuration difficult. Avoid any custom themes at all if it can be
1697     * helped.
1698     */
1699    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1700    /**
1701     * Get the specific theme to be used
1702     *
1703     * @param obj The object to get the specific theme from
1704     * @return The specifc theme set.
1705     *
1706     * This will return a specific theme set, or NULL if no specific theme is
1707     * set on that object. It will not return inherited themes from parents, only
1708     * the specific theme set for that specific object. See elm_object_theme_set()
1709     * for more information.
1710     */
1711    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1712    /**
1713     * @}
1714     */
1715
1716    /* win */
1717    /** @defgroup Win Win
1718     *
1719     * @image html img/widget/win/preview-00.png
1720     * @image latex img/widget/win/preview-00.eps
1721     *
1722     * The window class of Elementary.  Contains functions to manipulate
1723     * windows. The Evas engine used to render the window contents is specified
1724     * in the system or user elementary config files (whichever is found last),
1725     * and can be overridden with the ELM_ENGINE environment variable for
1726     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
1727     * compilation setup and modules actually installed at runtime) are (listed
1728     * in order of best supported and most likely to be complete and work to
1729     * lowest quality).
1730     *
1731     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1732     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1733     * rendering in X11)
1734     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1735     * exits)
1736     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1737     * rendering)
1738     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1739     * buffer)
1740     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1741     * rendering using SDL as the buffer)
1742     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1743     * GDI with software)
1744     * @li "dfb", "directfb" (Rendering to a DirectFB window)
1745     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1746     * grayscale using dedicated 8bit software engine in X11)
1747     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1748     * X11 using 16bit software engine)
1749     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1750     * (Windows CE rendering via GDI with 16bit software renderer)
1751     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1752     * buffer with 16bit software renderer)
1753     *
1754     * All engines use a simple string to select the engine to render, EXCEPT
1755     * the "shot" engine. This actually encodes the output of the virtual
1756     * screenshot and how long to delay in the engine string. The engine string
1757     * is encoded in the following way:
1758     *
1759     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1760     *
1761     * Where options are separated by a ":" char if more than one option is
1762     * given, with delay, if provided being the first option and file the last
1763     * (order is important). The delay specifies how long to wait after the
1764     * window is shown before doing the virtual "in memory" rendering and then
1765     * save the output to the file specified by the file option (and then exit).
1766     * If no delay is given, the default is 0.5 seconds. If no file is given the
1767     * default output file is "out.png". Repeat option is for continous
1768     * capturing screenshots. Repeat range is from 1 to 999 and filename is
1769     * fixed to "out001.png" Some examples of using the shot engine:
1770     *
1771     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
1772     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
1773     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
1774     *   ELM_ENGINE="shot:delay=2.0" elementary_test
1775     *   ELM_ENGINE="shot:" elementary_test
1776     *
1777     * Signals that you can add callbacks for are:
1778     *
1779     * @li "delete,request": the user requested to close the window. See
1780     * elm_win_autodel_set().
1781     * @li "focus,in": window got focus
1782     * @li "focus,out": window lost focus
1783     * @li "moved": window that holds the canvas was moved
1784     *
1785     * Examples:
1786     * @li @ref win_example_01
1787     *
1788     * @{
1789     */
1790    /**
1791     * Defines the types of window that can be created
1792     *
1793     * These are hints set on the window so that a running Window Manager knows
1794     * how the window should be handled and/or what kind of decorations it
1795     * should have.
1796     *
1797     * Currently, only the X11 backed engines use them.
1798     */
1799    typedef enum _Elm_Win_Type
1800      {
1801         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
1802                          window. Almost every window will be created with this
1803                          type. */
1804         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
1805         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
1806                            window holding desktop icons. */
1807         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
1808                         be kept on top of any other window by the Window
1809                         Manager. */
1810         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
1811                            similar. */
1812         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
1813         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
1814                            pallete. */
1815         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
1816         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
1817                                  entry in a menubar is clicked. Typically used
1818                                  with elm_win_override_set(). This hint exists
1819                                  for completion only, as the EFL way of
1820                                  implementing a menu would not normally use a
1821                                  separate window for its contents. */
1822         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
1823                               triggered by right-clicking an object. */
1824         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
1825                            explanatory text that typically appear after the
1826                            mouse cursor hovers over an object for a while.
1827                            Typically used with elm_win_override_set() and also
1828                            not very commonly used in the EFL. */
1829         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
1830                                 battery life or a new E-Mail received. */
1831         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
1832                          usually used in the EFL. */
1833         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
1834                        object being dragged across different windows, or even
1835                        applications. Typically used with
1836                        elm_win_override_set(). */
1837         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
1838                                  buffer. No actual window is created for this
1839                                  type, instead the window and all of its
1840                                  contents will be rendered to an image buffer.
1841                                  This allows to have children window inside a
1842                                  parent one just like any other object would
1843                                  be, and do other things like applying @c
1844                                  Evas_Map effects to it. This is the only type
1845                                  of window that requires the @c parent
1846                                  parameter of elm_win_add() to be a valid @c
1847                                  Evas_Object. */
1848      } Elm_Win_Type;
1849
1850    /**
1851     * The differents layouts that can be requested for the virtual keyboard.
1852     *
1853     * When the application window is being managed by Illume, it may request
1854     * any of the following layouts for the virtual keyboard.
1855     */
1856    typedef enum _Elm_Win_Keyboard_Mode
1857      {
1858         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
1859         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
1860         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
1861         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
1862         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
1863         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
1864         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
1865         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
1866         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
1867         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
1868         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
1869         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
1870         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
1871         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
1872         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
1873         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
1874      } Elm_Win_Keyboard_Mode;
1875
1876    /**
1877     * Available commands that can be sent to the Illume manager.
1878     *
1879     * When running under an Illume session, a window may send commands to the
1880     * Illume manager to perform different actions.
1881     */
1882    typedef enum _Elm_Illume_Command
1883      {
1884         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
1885                                          window */
1886         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
1887                                             in the list */
1888         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
1889                                          screen */
1890         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
1891      } Elm_Illume_Command;
1892
1893    /**
1894     * Adds a window object. If this is the first window created, pass NULL as
1895     * @p parent.
1896     *
1897     * @param parent Parent object to add the window to, or NULL
1898     * @param name The name of the window
1899     * @param type The window type, one of #Elm_Win_Type.
1900     *
1901     * The @p parent paramter can be @c NULL for every window @p type except
1902     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
1903     * which the image object will be created.
1904     *
1905     * @return The created object, or NULL on failure
1906     */
1907    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
1908    /**
1909     * Add @p subobj as a resize object of window @p obj.
1910     *
1911     *
1912     * Setting an object as a resize object of the window means that the
1913     * @p subobj child's size and position will be controlled by the window
1914     * directly. That is, the object will be resized to match the window size
1915     * and should never be moved or resized manually by the developer.
1916     *
1917     * In addition, resize objects of the window control what the minimum size
1918     * of it will be, as well as whether it can or not be resized by the user.
1919     *
1920     * For the end user to be able to resize a window by dragging the handles
1921     * or borders provided by the Window Manager, or using any other similar
1922     * mechanism, all of the resize objects in the window should have their
1923     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
1924     *
1925     * @param obj The window object
1926     * @param subobj The resize object to add
1927     */
1928    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1929    /**
1930     * Delete @p subobj as a resize object of window @p obj.
1931     *
1932     * This function removes the object @p subobj from the resize objects of
1933     * the window @p obj. It will not delete the object itself, which will be
1934     * left unmanaged and should be deleted by the developer, manually handled
1935     * or set as child of some other container.
1936     *
1937     * @param obj The window object
1938     * @param subobj The resize object to add
1939     */
1940    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
1941    /**
1942     * Set the title of the window
1943     *
1944     * @param obj The window object
1945     * @param title The title to set
1946     */
1947    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
1948    /**
1949     * Get the title of the window
1950     *
1951     * The returned string is an internal one and should not be freed or
1952     * modified. It will also be rendered invalid if a new title is set or if
1953     * the window is destroyed.
1954     *
1955     * @param obj The window object
1956     * @return The title
1957     */
1958    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1959    /**
1960     * Set the window's autodel state.
1961     *
1962     * When closing the window in any way outside of the program control, like
1963     * pressing the X button in the titlebar or using a command from the
1964     * Window Manager, a "delete,request" signal is emitted to indicate that
1965     * this event occurred and the developer can take any action, which may
1966     * include, or not, destroying the window object.
1967     *
1968     * When the @p autodel parameter is set, the window will be automatically
1969     * destroyed when this event occurs, after the signal is emitted.
1970     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
1971     * and is up to the program to do so when it's required.
1972     *
1973     * @param obj The window object
1974     * @param autodel If true, the window will automatically delete itself when
1975     * closed
1976     */
1977    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
1978    /**
1979     * Get the window's autodel state.
1980     *
1981     * @param obj The window object
1982     * @return If the window will automatically delete itself when closed
1983     *
1984     * @see elm_win_autodel_set()
1985     */
1986    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1987    /**
1988     * Activate a window object.
1989     *
1990     * This function sends a request to the Window Manager to activate the
1991     * window pointed by @p obj. If honored by the WM, the window will receive
1992     * the keyboard focus.
1993     *
1994     * @note This is just a request that a Window Manager may ignore, so calling
1995     * this function does not ensure in any way that the window will be the
1996     * active one after it.
1997     *
1998     * @param obj The window object
1999     */
2000    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2001    /**
2002     * Lower a window object.
2003     *
2004     * Places the window pointed by @p obj at the bottom of the stack, so that
2005     * no other window is covered by it.
2006     *
2007     * If elm_win_override_set() is not set, the Window Manager may ignore this
2008     * request.
2009     *
2010     * @param obj The window object
2011     */
2012    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2013    /**
2014     * Raise a window object.
2015     *
2016     * Places the window pointed by @p obj at the top of the stack, so that it's
2017     * not covered by any other window.
2018     *
2019     * If elm_win_override_set() is not set, the Window Manager may ignore this
2020     * request.
2021     *
2022     * @param obj The window object
2023     */
2024    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2025    /**
2026     * Set the borderless state of a window.
2027     *
2028     * This function requests the Window Manager to not draw any decoration
2029     * around the window.
2030     *
2031     * @param obj The window object
2032     * @param borderless If true, the window is borderless
2033     */
2034    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2035    /**
2036     * Get the borderless state of a window.
2037     *
2038     * @param obj The window object
2039     * @return If true, the window is borderless
2040     */
2041    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2042    /**
2043     * Set the shaped state of a window.
2044     *
2045     * Shaped windows, when supported, will render the parts of the window that
2046     * has no content, transparent.
2047     *
2048     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2049     * background object or cover the entire window in any other way, or the
2050     * parts of the canvas that have no data will show framebuffer artifacts.
2051     *
2052     * @param obj The window object
2053     * @param shaped If true, the window is shaped
2054     *
2055     * @see elm_win_alpha_set()
2056     */
2057    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2058    /**
2059     * Get the shaped state of a window.
2060     *
2061     * @param obj The window object
2062     * @return If true, the window is shaped
2063     *
2064     * @see elm_win_shaped_set()
2065     */
2066    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2067    /**
2068     * Set the alpha channel state of a window.
2069     *
2070     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2071     * possibly making parts of the window completely or partially transparent.
2072     * This is also subject to the underlying system supporting it, like for
2073     * example, running under a compositing manager. If no compositing is
2074     * available, enabling this option will instead fallback to using shaped
2075     * windows, with elm_win_shaped_set().
2076     *
2077     * @param obj The window object
2078     * @param alpha If true, the window has an alpha channel
2079     *
2080     * @see elm_win_alpha_set()
2081     */
2082    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2083    /**
2084     * Get the transparency state of a window.
2085     *
2086     * @param obj The window object
2087     * @return If true, the window is transparent
2088     *
2089     * @see elm_win_transparent_set()
2090     */
2091    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2092    /**
2093     * Set the transparency state of a window.
2094     *
2095     * Use elm_win_alpha_set() instead.
2096     *
2097     * @param obj The window object
2098     * @param transparent If true, the window is transparent
2099     *
2100     * @see elm_win_alpha_set()
2101     */
2102    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2103    /**
2104     * Get the alpha channel state of a window.
2105     *
2106     * @param obj The window object
2107     * @return If true, the window has an alpha channel
2108     */
2109    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2110    /**
2111     * Set the override state of a window.
2112     *
2113     * A window with @p override set to EINA_TRUE will not be managed by the
2114     * Window Manager. This means that no decorations of any kind will be shown
2115     * for it, moving and resizing must be handled by the application, as well
2116     * as the window visibility.
2117     *
2118     * This should not be used for normal windows, and even for not so normal
2119     * ones, it should only be used when there's a good reason and with a lot
2120     * of care. Mishandling override windows may result situations that
2121     * disrupt the normal workflow of the end user.
2122     *
2123     * @param obj The window object
2124     * @param override If true, the window is overridden
2125     */
2126    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2127    /**
2128     * Get the override state of a window.
2129     *
2130     * @param obj The window object
2131     * @return If true, the window is overridden
2132     *
2133     * @see elm_win_override_set()
2134     */
2135    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2136    /**
2137     * Set the fullscreen state of a window.
2138     *
2139     * @param obj The window object
2140     * @param fullscreen If true, the window is fullscreen
2141     */
2142    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2143    /**
2144     * Get the fullscreen state of a window.
2145     *
2146     * @param obj The window object
2147     * @return If true, the window is fullscreen
2148     */
2149    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2150    /**
2151     * Set the maximized state of a window.
2152     *
2153     * @param obj The window object
2154     * @param maximized If true, the window is maximized
2155     */
2156    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2157    /**
2158     * Get the maximized state of a window.
2159     *
2160     * @param obj The window object
2161     * @return If true, the window is maximized
2162     */
2163    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2164    /**
2165     * Set the iconified state of a window.
2166     *
2167     * @param obj The window object
2168     * @param iconified If true, the window is iconified
2169     */
2170    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2171    /**
2172     * Get the iconified state of a window.
2173     *
2174     * @param obj The window object
2175     * @return If true, the window is iconified
2176     */
2177    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2178    /**
2179     * Set the layer of the window.
2180     *
2181     * What this means exactly will depend on the underlying engine used.
2182     *
2183     * In the case of X11 backed engines, the value in @p layer has the
2184     * following meanings:
2185     * @li < 3: The window will be placed below all others.
2186     * @li > 5: The window will be placed above all others.
2187     * @li other: The window will be placed in the default layer.
2188     *
2189     * @param obj The window object
2190     * @param layer The layer of the window
2191     */
2192    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2193    /**
2194     * Get the layer of the window.
2195     *
2196     * @param obj The window object
2197     * @return The layer of the window
2198     *
2199     * @see elm_win_layer_set()
2200     */
2201    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2202    /**
2203     * Set the rotation of the window.
2204     *
2205     * Most engines only work with multiples of 90.
2206     *
2207     * This function is used to set the orientation of the window @p obj to
2208     * match that of the screen. The window itself will be resized to adjust
2209     * to the new geometry of its contents. If you want to keep the window size,
2210     * see elm_win_rotation_with_resize_set().
2211     *
2212     * @param obj The window object
2213     * @param rotation The rotation of the window, in degrees (0-360),
2214     * counter-clockwise.
2215     */
2216    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2217    /**
2218     * Rotates the window and resizes it.
2219     *
2220     * Like elm_win_rotation_set(), but it also resizes the window's contents so
2221     * that they fit inside the current window geometry.
2222     *
2223     * @param obj The window object
2224     * @param layer The rotation of the window in degrees (0-360),
2225     * counter-clockwise.
2226     */
2227    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2228    /**
2229     * Get the rotation of the window.
2230     *
2231     * @param obj The window object
2232     * @return The rotation of the window in degrees (0-360)
2233     *
2234     * @see elm_win_rotation_set()
2235     * @see elm_win_rotation_with_resize_set()
2236     */
2237    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2238    /**
2239     * Set the sticky state of the window.
2240     *
2241     * Hints the Window Manager that the window in @p obj should be left fixed
2242     * at its position even when the virtual desktop it's on moves or changes.
2243     *
2244     * @param obj The window object
2245     * @param sticky If true, the window's sticky state is enabled
2246     */
2247    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2248    /**
2249     * Get the sticky state of the window.
2250     *
2251     * @param obj The window object
2252     * @return If true, the window's sticky state is enabled
2253     *
2254     * @see elm_win_sticky_set()
2255     */
2256    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2257    /**
2258     * Set if this window is an illume conformant window
2259     *
2260     * @param obj The window object
2261     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2262     */
2263    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2264    /**
2265     * Get if this window is an illume conformant window
2266     *
2267     * @param obj The window object
2268     * @return A boolean if this window is illume conformant or not
2269     */
2270    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2271    /**
2272     * Set a window to be an illume quickpanel window
2273     *
2274     * By default window objects are not quickpanel windows.
2275     *
2276     * @param obj The window object
2277     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2278     */
2279    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2280    /**
2281     * Get if this window is a quickpanel or not
2282     *
2283     * @param obj The window object
2284     * @return A boolean if this window is a quickpanel or not
2285     */
2286    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2287    /**
2288     * Set the major priority of a quickpanel window
2289     *
2290     * @param obj The window object
2291     * @param priority The major priority for this quickpanel
2292     */
2293    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2294    /**
2295     * Get the major priority of a quickpanel window
2296     *
2297     * @param obj The window object
2298     * @return The major priority of this quickpanel
2299     */
2300    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2301    /**
2302     * Set the minor priority of a quickpanel window
2303     *
2304     * @param obj The window object
2305     * @param priority The minor priority for this quickpanel
2306     */
2307    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2308    /**
2309     * Get the minor priority of a quickpanel window
2310     *
2311     * @param obj The window object
2312     * @return The minor priority of this quickpanel
2313     */
2314    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2315    /**
2316     * Set which zone this quickpanel should appear in
2317     *
2318     * @param obj The window object
2319     * @param zone The requested zone for this quickpanel
2320     */
2321    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2322    /**
2323     * Get which zone this quickpanel should appear in
2324     *
2325     * @param obj The window object
2326     * @return The requested zone for this quickpanel
2327     */
2328    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2329    /**
2330     * Set the window to be skipped by keyboard focus
2331     *
2332     * This sets the window to be skipped by normal keyboard input. This means
2333     * a window manager will be asked to not focus this window as well as omit
2334     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2335     *
2336     * Call this and enable it on a window BEFORE you show it for the first time,
2337     * otherwise it may have no effect.
2338     *
2339     * Use this for windows that have only output information or might only be
2340     * interacted with by the mouse or fingers, and never for typing input.
2341     * Be careful that this may have side-effects like making the window
2342     * non-accessible in some cases unless the window is specially handled. Use
2343     * this with care.
2344     *
2345     * @param obj The window object
2346     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2347     */
2348    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2349    /**
2350     * Send a command to the windowing environment
2351     *
2352     * This is intended to work in touchscreen or small screen device
2353     * environments where there is a more simplistic window management policy in
2354     * place. This uses the window object indicated to select which part of the
2355     * environment to control (the part that this window lives in), and provides
2356     * a command and an optional parameter structure (use NULL for this if not
2357     * needed).
2358     *
2359     * @param obj The window object that lives in the environment to control
2360     * @param command The command to send
2361     * @param params Optional parameters for the command
2362     */
2363    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2364    /**
2365     * Get the inlined image object handle
2366     *
2367     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2368     * then the window is in fact an evas image object inlined in the parent
2369     * canvas. You can get this object (be careful to not manipulate it as it
2370     * is under control of elementary), and use it to do things like get pixel
2371     * data, save the image to a file, etc.
2372     *
2373     * @param obj The window object to get the inlined image from
2374     * @return The inlined image object, or NULL if none exists
2375     */
2376    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2377    /**
2378     * Set the enabled status for the focus highlight in a window
2379     *
2380     * This function will enable or disable the focus highlight only for the
2381     * given window, regardless of the global setting for it
2382     *
2383     * @param obj The window where to enable the highlight
2384     * @param enabled The enabled value for the highlight
2385     */
2386    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2387    /**
2388     * Get the enabled value of the focus highlight for this window
2389     *
2390     * @param obj The window in which to check if the focus highlight is enabled
2391     *
2392     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2393     */
2394    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2395    /**
2396     * Set the style for the focus highlight on this window
2397     *
2398     * Sets the style to use for theming the highlight of focused objects on
2399     * the given window. If @p style is NULL, the default will be used.
2400     *
2401     * @param obj The window where to set the style
2402     * @param style The style to set
2403     */
2404    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2405    /**
2406     * Get the style set for the focus highlight object
2407     *
2408     * Gets the style set for this windows highilght object, or NULL if none
2409     * is set.
2410     *
2411     * @param obj The window to retrieve the highlights style from
2412     *
2413     * @return The style set or NULL if none was. Default is used in that case.
2414     */
2415    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2416    /*...
2417     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2418     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2419     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2420     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2421     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2422     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2423     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2424     *
2425     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2426     * (blank mouse, private mouse obj, defaultmouse)
2427     *
2428     */
2429    /**
2430     * Sets the keyboard mode of the window.
2431     *
2432     * @param obj The window object
2433     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2434     */
2435    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2436    /**
2437     * Gets the keyboard mode of the window.
2438     *
2439     * @param obj The window object
2440     * @return The mode, one of #Elm_Win_Keyboard_Mode
2441     */
2442    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2443    /**
2444     * Sets whether the window is a keyboard.
2445     *
2446     * @param obj The window object
2447     * @param is_keyboard If true, the window is a virtual keyboard
2448     */
2449    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2450    /**
2451     * Gets whether the window is a keyboard.
2452     *
2453     * @param obj The window object
2454     * @return If the window is a virtual keyboard
2455     */
2456    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2457
2458    /**
2459     * Get the screen position of a window.
2460     *
2461     * @param obj The window object
2462     * @param x The int to store the x coordinate to
2463     * @param y The int to store the y coordinate to
2464     */
2465    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2466    /**
2467     * @}
2468     */
2469
2470    /**
2471     * @defgroup Inwin Inwin
2472     *
2473     * @image html img/widget/inwin/preview-00.png
2474     * @image latex img/widget/inwin/preview-00.eps
2475     * @image html img/widget/inwin/preview-01.png
2476     * @image latex img/widget/inwin/preview-01.eps
2477     * @image html img/widget/inwin/preview-02.png
2478     * @image latex img/widget/inwin/preview-02.eps
2479     *
2480     * An inwin is a window inside a window that is useful for a quick popup.
2481     * It does not hover.
2482     *
2483     * It works by creating an object that will occupy the entire window, so it
2484     * must be created using an @ref Win "elm_win" as parent only. The inwin
2485     * object can be hidden or restacked below every other object if it's
2486     * needed to show what's behind it without destroying it. If this is done,
2487     * the elm_win_inwin_activate() function can be used to bring it back to
2488     * full visibility again.
2489     *
2490     * There are three styles available in the default theme. These are:
2491     * @li default: The inwin is sized to take over most of the window it's
2492     * placed in.
2493     * @li minimal: The size of the inwin will be the minimum necessary to show
2494     * its contents.
2495     * @li minimal_vertical: Horizontally, the inwin takes as much space as
2496     * possible, but it's sized vertically the most it needs to fit its\
2497     * contents.
2498     *
2499     * Some examples of Inwin can be found in the following:
2500     * @li @ref inwin_example_01
2501     *
2502     * @{
2503     */
2504    /**
2505     * Adds an inwin to the current window
2506     *
2507     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2508     * Never call this function with anything other than the top-most window
2509     * as its parameter, unless you are fond of undefined behavior.
2510     *
2511     * After creating the object, the widget will set itself as resize object
2512     * for the window with elm_win_resize_object_add(), so when shown it will
2513     * appear to cover almost the entire window (how much of it depends on its
2514     * content and the style used). It must not be added into other container
2515     * objects and it needs not be moved or resized manually.
2516     *
2517     * @param parent The parent object
2518     * @return The new object or NULL if it cannot be created
2519     */
2520    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2521    /**
2522     * Activates an inwin object, ensuring its visibility
2523     *
2524     * This function will make sure that the inwin @p obj is completely visible
2525     * by calling evas_object_show() and evas_object_raise() on it, to bring it
2526     * to the front. It also sets the keyboard focus to it, which will be passed
2527     * onto its content.
2528     *
2529     * The object's theme will also receive the signal "elm,action,show" with
2530     * source "elm".
2531     *
2532     * @param obj The inwin to activate
2533     */
2534    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2535    /**
2536     * Set the content of an inwin object.
2537     *
2538     * Once the content object is set, a previously set one will be deleted.
2539     * If you want to keep that old content object, use the
2540     * elm_win_inwin_content_unset() function.
2541     *
2542     * @param obj The inwin object
2543     * @param content The object to set as content
2544     */
2545    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2546    /**
2547     * Get the content of an inwin object.
2548     *
2549     * Return the content object which is set for this widget.
2550     *
2551     * The returned object is valid as long as the inwin is still alive and no
2552     * other content is set on it. Deleting the object will notify the inwin
2553     * about it and this one will be left empty.
2554     *
2555     * If you need to remove an inwin's content to be reused somewhere else,
2556     * see elm_win_inwin_content_unset().
2557     *
2558     * @param obj The inwin object
2559     * @return The content that is being used
2560     */
2561    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2562    /**
2563     * Unset the content of an inwin object.
2564     *
2565     * Unparent and return the content object which was set for this widget.
2566     *
2567     * @param obj The inwin object
2568     * @return The content that was being used
2569     */
2570    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2571    /**
2572     * @}
2573     */
2574    /* X specific calls - won't work on non-x engines (return 0) */
2575    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2576    /* smart callbacks called:
2577     * "delete,request" - the user requested to delete the window
2578     * "focus,in" - window got focus
2579     * "focus,out" - window lost focus
2580     * "moved" - window that holds the canvas was moved
2581     */
2582
2583    /**
2584     * @defgroup Bg Bg
2585     *
2586     * @image html img/widget/bg/preview-00.png
2587     * @image latex img/widget/bg/preview-00.eps
2588     *
2589     * @brief Background object, used for setting a solid color, image or Edje
2590     * group as background to a window or any container object.
2591     *
2592     * The bg object is used for setting a solid background to a window or
2593     * packing into any container object. It works just like an image, but has
2594     * some properties useful to a background, like setting it to tiled,
2595     * centered, scaled or stretched.
2596     *
2597     * Here is some sample code using it:
2598     * @li @ref bg_01_example_page
2599     * @li @ref bg_02_example_page
2600     * @li @ref bg_03_example_page
2601     */
2602
2603    /* bg */
2604    typedef enum _Elm_Bg_Option
2605      {
2606         ELM_BG_OPTION_CENTER,  /**< center the background */
2607         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
2608         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2609         ELM_BG_OPTION_TILE     /**< tile background at its original size */
2610      } Elm_Bg_Option;
2611
2612    /**
2613     * Add a new background to the parent
2614     *
2615     * @param parent The parent object
2616     * @return The new object or NULL if it cannot be created
2617     *
2618     * @ingroup Bg
2619     */
2620    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2621
2622    /**
2623     * Set 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     * This sets the image file used in the background object. The image (or edje)
2630     * will be stretched (retaining aspect if its an image file) to completely fill
2631     * the bg object. This may mean some parts are not visible.
2632     *
2633     * @note  Once the image of @p obj is set, a previously set one will be deleted,
2634     * even if @p file is NULL.
2635     *
2636     * @ingroup Bg
2637     */
2638    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2639
2640    /**
2641     * Get the file (image or edje) used for the background
2642     *
2643     * @param obj The bg object
2644     * @param file The file path
2645     * @param group Optional key (group in Edje) within the file
2646     *
2647     * @ingroup Bg
2648     */
2649    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2650
2651    /**
2652     * Set the option used for the background image
2653     *
2654     * @param obj The bg object
2655     * @param option The desired background option (TILE, SCALE)
2656     *
2657     * This sets the option used for manipulating the display of the background
2658     * image. The image can be tiled or scaled.
2659     *
2660     * @ingroup Bg
2661     */
2662    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2663
2664    /**
2665     * Get the option used for the background image
2666     *
2667     * @param obj The bg object
2668     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2669     *
2670     * @ingroup Bg
2671     */
2672    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2673    /**
2674     * Set the option used for the background color
2675     *
2676     * @param obj The bg object
2677     * @param r
2678     * @param g
2679     * @param b
2680     *
2681     * This sets the color used for the background rectangle. Its range goes
2682     * from 0 to 255.
2683     *
2684     * @ingroup Bg
2685     */
2686    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2687    /**
2688     * Get the option used for the background color
2689     *
2690     * @param obj The bg object
2691     * @param r
2692     * @param g
2693     * @param b
2694     *
2695     * @ingroup Bg
2696     */
2697    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2698
2699    /**
2700     * Set the overlay object used for the background object.
2701     *
2702     * @param obj The bg object
2703     * @param overlay The overlay object
2704     *
2705     * This provides a way for elm_bg to have an 'overlay' that will be on top
2706     * of the bg. Once the over object is set, a previously set one will be
2707     * deleted, even if you set the new one to NULL. If you want to keep that
2708     * old content object, use the elm_bg_overlay_unset() function.
2709     *
2710     * @ingroup Bg
2711     */
2712
2713    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2714
2715    /**
2716     * Get the overlay object used for the background object.
2717     *
2718     * @param obj The bg object
2719     * @return The content that is being used
2720     *
2721     * Return the content object which is set for this widget
2722     *
2723     * @ingroup Bg
2724     */
2725    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2726
2727    /**
2728     * Get the overlay object used for the background object.
2729     *
2730     * @param obj The bg object
2731     * @return The content that was being used
2732     *
2733     * Unparent and return the overlay object which was set for this widget
2734     *
2735     * @ingroup Bg
2736     */
2737    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2738
2739    /**
2740     * Set the size of the pixmap representation of the image.
2741     *
2742     * This option just makes sense if an image is going to be set in the bg.
2743     *
2744     * @param obj The bg object
2745     * @param w The new width of the image pixmap representation.
2746     * @param h The new height of the image pixmap representation.
2747     *
2748     * This function sets a new size for pixmap representation of the given bg
2749     * image. It allows the image to be loaded already in the specified size,
2750     * reducing the memory usage and load time when loading a big image with load
2751     * size set to a smaller size.
2752     *
2753     * NOTE: this is just a hint, the real size of the pixmap may differ
2754     * depending on the type of image being loaded, being bigger than requested.
2755     *
2756     * @ingroup Bg
2757     */
2758    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2759    /* smart callbacks called:
2760     */
2761
2762    /**
2763     * @defgroup Icon Icon
2764     *
2765     * @image html img/widget/icon/preview-00.png
2766     * @image latex img/widget/icon/preview-00.eps
2767     *
2768     * An object that provides standard icon images (delete, edit, arrows, etc.)
2769     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2770     *
2771     * The icon image requested can be in the elementary theme, or in the
2772     * freedesktop.org paths. It's possible to set the order of preference from
2773     * where the image will be used.
2774     *
2775     * This API is very similar to @ref Image, but with ready to use images.
2776     *
2777     * Default images provided by the theme are described below.
2778     *
2779     * The first list contains icons that were first intended to be used in
2780     * toolbars, but can be used in many other places too:
2781     * @li home
2782     * @li close
2783     * @li apps
2784     * @li arrow_up
2785     * @li arrow_down
2786     * @li arrow_left
2787     * @li arrow_right
2788     * @li chat
2789     * @li clock
2790     * @li delete
2791     * @li edit
2792     * @li refresh
2793     * @li folder
2794     * @li file
2795     *
2796     * Now some icons that were designed to be used in menus (but again, you can
2797     * use them anywhere else):
2798     * @li menu/home
2799     * @li menu/close
2800     * @li menu/apps
2801     * @li menu/arrow_up
2802     * @li menu/arrow_down
2803     * @li menu/arrow_left
2804     * @li menu/arrow_right
2805     * @li menu/chat
2806     * @li menu/clock
2807     * @li menu/delete
2808     * @li menu/edit
2809     * @li menu/refresh
2810     * @li menu/folder
2811     * @li menu/file
2812     *
2813     * And here we have some media player specific icons:
2814     * @li media_player/forward
2815     * @li media_player/info
2816     * @li media_player/next
2817     * @li media_player/pause
2818     * @li media_player/play
2819     * @li media_player/prev
2820     * @li media_player/rewind
2821     * @li media_player/stop
2822     *
2823     * Signals that you can add callbacks for are:
2824     *
2825     * "clicked" - This is called when a user has clicked the icon
2826     *
2827     * An example of usage for this API follows:
2828     * @li @ref tutorial_icon
2829     */
2830
2831    /**
2832     * @addtogroup Icon
2833     * @{
2834     */
2835
2836    typedef enum _Elm_Icon_Type
2837      {
2838         ELM_ICON_NONE,
2839         ELM_ICON_FILE,
2840         ELM_ICON_STANDARD
2841      } Elm_Icon_Type;
2842    /**
2843     * @enum _Elm_Icon_Lookup_Order
2844     * @typedef Elm_Icon_Lookup_Order
2845     *
2846     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
2847     * theme, FDO paths, or both?
2848     *
2849     * @ingroup Icon
2850     */
2851    typedef enum _Elm_Icon_Lookup_Order
2852      {
2853         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2854         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2855         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
2856         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
2857      } Elm_Icon_Lookup_Order;
2858
2859    /**
2860     * Add a new icon object to the parent.
2861     *
2862     * @param parent The parent object
2863     * @return The new object or NULL if it cannot be created
2864     *
2865     * @see elm_icon_file_set()
2866     *
2867     * @ingroup Icon
2868     */
2869    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2870    /**
2871     * Set the file that will be used as icon.
2872     *
2873     * @param obj The icon object
2874     * @param file The path to file that will be used as icon image
2875     * @param group The group that the icon belongs to in edje file
2876     *
2877     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2878     *
2879     * @note The icon image set by this function can be changed by
2880     * elm_icon_standard_set().
2881     *
2882     * @see elm_icon_file_get()
2883     *
2884     * @ingroup Icon
2885     */
2886    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2887    /**
2888     * Set a location in memory to be used as an icon
2889     *
2890     * @param obj The icon object
2891     * @param img The binary data that will be used as an image
2892     * @param size The size of binary data @p img
2893     * @param format Optional format of @p img to pass to the image loader
2894     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
2895     *
2896     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2897     *
2898     * @note The icon image set by this function can be changed by
2899     * elm_icon_standard_set().
2900     *
2901     * @ingroup Icon
2902     */
2903    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);
2904    /**
2905     * Get the file that will be used as icon.
2906     *
2907     * @param obj The icon object
2908     * @param file The path to file that will be used as icon icon image
2909     * @param group The group that the icon belongs to in edje file
2910     *
2911     * @see elm_icon_file_set()
2912     *
2913     * @ingroup Icon
2914     */
2915    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2916    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2917    /**
2918     * Set the icon by icon standards names.
2919     *
2920     * @param obj The icon object
2921     * @param name The icon name
2922     *
2923     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
2924     *
2925     * For example, freedesktop.org defines standard icon names such as "home",
2926     * "network", etc. There can be different icon sets to match those icon
2927     * keys. The @p name given as parameter is one of these "keys", and will be
2928     * used to look in the freedesktop.org paths and elementary theme. One can
2929     * change the lookup order with elm_icon_order_lookup_set().
2930     *
2931     * If name is not found in any of the expected locations and it is the
2932     * absolute path of an image file, this image will be used.
2933     *
2934     * @note The icon image set by this function can be changed by
2935     * elm_icon_file_set().
2936     *
2937     * @see elm_icon_standard_get()
2938     * @see elm_icon_file_set()
2939     *
2940     * @ingroup Icon
2941     */
2942    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2943    /**
2944     * Get the icon name set by icon standard names.
2945     *
2946     * @param obj The icon object
2947     * @return The icon name
2948     *
2949     * If the icon image was set using elm_icon_file_set() instead of
2950     * elm_icon_standard_set(), then this function will return @c NULL.
2951     *
2952     * @see elm_icon_standard_set()
2953     *
2954     * @ingroup Icon
2955     */
2956    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2957    /**
2958     * Set the smooth effect for an icon object.
2959     *
2960     * @param obj The icon object
2961     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
2962     * otherwise. Default is @c EINA_TRUE.
2963     *
2964     * Set the scaling algorithm to be used when scaling the icon image. Smooth
2965     * scaling provides a better resulting image, but is slower.
2966     *
2967     * The smooth scaling should be disabled when making animations that change
2968     * the icon size, since they will be faster. Animations that don't require
2969     * resizing of the icon can keep the smooth scaling enabled (even if the icon
2970     * is already scaled, since the scaled icon image will be cached).
2971     *
2972     * @see elm_icon_smooth_get()
2973     *
2974     * @ingroup Icon
2975     */
2976    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2977    /**
2978     * Get the smooth effect for an icon object.
2979     *
2980     * @param obj The icon object
2981     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
2982     *
2983     * @see elm_icon_smooth_set()
2984     *
2985     * @ingroup Icon
2986     */
2987    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2988    /**
2989     * Disable scaling of this object.
2990     *
2991     * @param obj The icon object.
2992     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
2993     * otherwise. Default is @c EINA_FALSE.
2994     *
2995     * This function disables scaling of the icon object through the function
2996     * elm_object_scale_set(). However, this does not affect the object
2997     * size/resize in any way. For that effect, take a look at
2998     * elm_icon_scale_set().
2999     *
3000     * @see elm_icon_no_scale_get()
3001     * @see elm_icon_scale_set()
3002     * @see elm_object_scale_set()
3003     *
3004     * @ingroup Icon
3005     */
3006    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3007    /**
3008     * Get whether scaling is disabled on the object.
3009     *
3010     * @param obj The icon object
3011     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3012     *
3013     * @see elm_icon_no_scale_set()
3014     *
3015     * @ingroup Icon
3016     */
3017    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3018    /**
3019     * Set 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. Default is
3023     * @c EINA_TRUE.
3024     * @param scale_down A bool to set if the object is resizeable down. Default
3025     * is @c EINA_TRUE.
3026     *
3027     * This function limits the icon object resize ability. If @p scale_up is set to
3028     * @c EINA_FALSE, the object can't have its height or width resized to a value
3029     * higher than the original icon size. Same is valid for @p scale_down.
3030     *
3031     * @see elm_icon_scale_get()
3032     *
3033     * @ingroup Icon
3034     */
3035    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3036    /**
3037     * Get if the object is (up/down) resizeable.
3038     *
3039     * @param obj The icon object
3040     * @param scale_up A bool to set if the object is resizeable up
3041     * @param scale_down A bool to set if the object is resizeable down
3042     *
3043     * @see elm_icon_scale_set()
3044     *
3045     * @ingroup Icon
3046     */
3047    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3048    /**
3049     * Get the object's image size
3050     *
3051     * @param obj The icon object
3052     * @param w A pointer to store the width in
3053     * @param h A pointer to store the height in
3054     *
3055     * @ingroup Icon
3056     */
3057    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3058    /**
3059     * Set if the icon fill the entire object area.
3060     *
3061     * @param obj The icon object
3062     * @param fill_outside @c EINA_TRUE if the object is filled outside,
3063     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3064     *
3065     * When the icon object is resized to a different aspect ratio from the
3066     * original icon image, the icon image will still keep its aspect. This flag
3067     * tells how the image should fill the object's area. They are: keep the
3068     * entire icon inside the limits of height and width of the object (@p
3069     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3070     * of the object, and the icon will fill the entire object (@p fill_outside
3071     * is @c EINA_TRUE).
3072     *
3073     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3074     * retain property to false. Thus, the icon image will always keep its
3075     * original aspect ratio.
3076     *
3077     * @see elm_icon_fill_outside_get()
3078     * @see elm_image_fill_outside_set()
3079     *
3080     * @ingroup Icon
3081     */
3082    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3083    /**
3084     * Get if the object is filled outside.
3085     *
3086     * @param obj The icon object
3087     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3088     *
3089     * @see elm_icon_fill_outside_set()
3090     *
3091     * @ingroup Icon
3092     */
3093    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3094    /**
3095     * Set the prescale size for the icon.
3096     *
3097     * @param obj The icon object
3098     * @param size The prescale size. This value is used for both width and
3099     * height.
3100     *
3101     * This function sets a new size for pixmap representation of the given
3102     * icon. It allows the icon to be loaded already in the specified size,
3103     * reducing the memory usage and load time when loading a big icon with load
3104     * size set to a smaller size.
3105     *
3106     * It's equivalent to the elm_bg_load_size_set() function for bg.
3107     *
3108     * @note this is just a hint, the real size of the pixmap may differ
3109     * depending on the type of icon being loaded, being bigger than requested.
3110     *
3111     * @see elm_icon_prescale_get()
3112     * @see elm_bg_load_size_set()
3113     *
3114     * @ingroup Icon
3115     */
3116    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3117    /**
3118     * Get the prescale size for the icon.
3119     *
3120     * @param obj The icon object
3121     * @return The prescale size
3122     *
3123     * @see elm_icon_prescale_set()
3124     *
3125     * @ingroup Icon
3126     */
3127    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3128    /**
3129     * Sets the icon lookup order used by elm_icon_standard_set().
3130     *
3131     * @param obj The icon object
3132     * @param order The icon lookup order (can be one of
3133     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3134     * or ELM_ICON_LOOKUP_THEME)
3135     *
3136     * @see elm_icon_order_lookup_get()
3137     * @see Elm_Icon_Lookup_Order
3138     *
3139     * @ingroup Icon
3140     */
3141    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3142    /**
3143     * Gets the icon lookup order.
3144     *
3145     * @param obj The icon object
3146     * @return The icon lookup order
3147     *
3148     * @see elm_icon_order_lookup_set()
3149     * @see Elm_Icon_Lookup_Order
3150     *
3151     * @ingroup Icon
3152     */
3153    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3154
3155    /**
3156     * @}
3157     */
3158
3159    /**
3160     * @defgroup Image Image
3161     *
3162     * @image html img/widget/image/preview-00.png
3163     * @image latex img/widget/image/preview-00.eps
3164     *
3165     * An object that allows one to load an image file to it. It can be used
3166     * anywhere like any other elementary widget.
3167     *
3168     * This widget provides most of the functionality provided from @ref Bg or @ref
3169     * Icon, but with a slightly different API (use the one that fits better your
3170     * needs).
3171     *
3172     * The features not provided by those two other image widgets are:
3173     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3174     * @li change the object orientation with elm_image_orient_set();
3175     * @li and turning the image editable with elm_image_editable_set().
3176     *
3177     * Signals that you can add callbacks for are:
3178     *
3179     * @li @c "clicked" - This is called when a user has clicked the image
3180     *
3181     * An example of usage for this API follows:
3182     * @li @ref tutorial_image
3183     */
3184
3185    /**
3186     * @addtogroup Image
3187     * @{
3188     */
3189
3190    /**
3191     * @enum _Elm_Image_Orient
3192     * @typedef Elm_Image_Orient
3193     *
3194     * Possible orientation options for elm_image_orient_set().
3195     *
3196     * @image html elm_image_orient_set.png
3197     * @image latex elm_image_orient_set.eps width=\textwidth
3198     *
3199     * @ingroup Image
3200     */
3201    typedef enum _Elm_Image_Orient
3202      {
3203         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3204         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3205         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3206         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3207         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3208         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3209         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3210         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3211      } Elm_Image_Orient;
3212
3213    /**
3214     * Add a new image to the parent.
3215     *
3216     * @param parent The parent object
3217     * @return The new object or NULL if it cannot be created
3218     *
3219     * @see elm_image_file_set()
3220     *
3221     * @ingroup Image
3222     */
3223    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3224    /**
3225     * Set the file that will be used as image.
3226     *
3227     * @param obj The image object
3228     * @param file The path to file that will be used as image
3229     * @param group The group that the image belongs in edje file (if it's an
3230     * edje image)
3231     *
3232     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3233     *
3234     * @see elm_image_file_get()
3235     *
3236     * @ingroup Image
3237     */
3238    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3239    /**
3240     * Get the file that will be used as image.
3241     *
3242     * @param obj The image object
3243     * @param file The path to file
3244     * @param group The group that the image belongs in edje file
3245     *
3246     * @see elm_image_file_set()
3247     *
3248     * @ingroup Image
3249     */
3250    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3251    /**
3252     * Set the smooth effect for an image.
3253     *
3254     * @param obj The image object
3255     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3256     * otherwise. Default is @c EINA_TRUE.
3257     *
3258     * Set the scaling algorithm to be used when scaling the image. Smooth
3259     * scaling provides a better resulting image, but is slower.
3260     *
3261     * The smooth scaling should be disabled when making animations that change
3262     * the image size, since it will be faster. Animations that don't require
3263     * resizing of the image can keep the smooth scaling enabled (even if the
3264     * image is already scaled, since the scaled image will be cached).
3265     *
3266     * @see elm_image_smooth_get()
3267     *
3268     * @ingroup Image
3269     */
3270    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3271    /**
3272     * Get the smooth effect for an image.
3273     *
3274     * @param obj The image object
3275     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3276     *
3277     * @see elm_image_smooth_get()
3278     *
3279     * @ingroup Image
3280     */
3281    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3282    /**
3283     * Gets the current size of the image.
3284     *
3285     * @param obj The image object.
3286     * @param w Pointer to store width, or NULL.
3287     * @param h Pointer to store height, or NULL.
3288     *
3289     * This is the real size of the image, not the size of the object.
3290     *
3291     * On error, neither w or h will be written.
3292     *
3293     * @ingroup Image
3294     */
3295    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3296    /**
3297     * Disable scaling of this object.
3298     *
3299     * @param obj The image object.
3300     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3301     * otherwise. Default is @c EINA_FALSE.
3302     *
3303     * This function disables scaling of the elm_image widget through the
3304     * function elm_object_scale_set(). However, this does not affect the widget
3305     * size/resize in any way. For that effect, take a look at
3306     * elm_image_scale_set().
3307     *
3308     * @see elm_image_no_scale_get()
3309     * @see elm_image_scale_set()
3310     * @see elm_object_scale_set()
3311     *
3312     * @ingroup Image
3313     */
3314    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3315    /**
3316     * Get whether scaling is disabled on the object.
3317     *
3318     * @param obj The image object
3319     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3320     *
3321     * @see elm_image_no_scale_set()
3322     *
3323     * @ingroup Image
3324     */
3325    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3326    /**
3327     * Set 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. Default is
3331     * @c EINA_TRUE.
3332     * @param scale_down A bool to set if the object is resizeable down. Default
3333     * is @c EINA_TRUE.
3334     *
3335     * This function limits the image resize ability. If @p scale_up is set to
3336     * @c EINA_FALSE, the object can't have its height or width resized to a value
3337     * higher than the original image size. Same is valid for @p scale_down.
3338     *
3339     * @see elm_image_scale_get()
3340     *
3341     * @ingroup Image
3342     */
3343    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3344    /**
3345     * Get if the object is (up/down) resizeable.
3346     *
3347     * @param obj The image object
3348     * @param scale_up A bool to set if the object is resizeable up
3349     * @param scale_down A bool to set if the object is resizeable down
3350     *
3351     * @see elm_image_scale_set()
3352     *
3353     * @ingroup Image
3354     */
3355    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3356    /**
3357     * Set if the image fill the entire object area when keeping the aspect ratio.
3358     *
3359     * @param obj The image object
3360     * @param fill_outside @c EINA_TRUE if the object is filled outside,
3361     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3362     *
3363     * When the image should keep its aspect ratio even if resized to another
3364     * aspect ratio, there are two possibilities to resize it: keep the entire
3365     * image inside the limits of height and width of the object (@p fill_outside
3366     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3367     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3368     *
3369     * @note This option will have no effect if
3370     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3371     *
3372     * @see elm_image_fill_outside_get()
3373     * @see elm_image_aspect_ratio_retained_set()
3374     *
3375     * @ingroup Image
3376     */
3377    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3378    /**
3379     * Get if the object is filled outside
3380     *
3381     * @param obj The image object
3382     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3383     *
3384     * @see elm_image_fill_outside_set()
3385     *
3386     * @ingroup Image
3387     */
3388    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3389    /**
3390     * Set the prescale size for the image
3391     *
3392     * @param obj The image object
3393     * @param size The prescale size. This value is used for both width and
3394     * height.
3395     *
3396     * This function sets a new size for pixmap representation of the given
3397     * image. It allows the image to be loaded already in the specified size,
3398     * reducing the memory usage and load time when loading a big image with load
3399     * size set to a smaller size.
3400     *
3401     * It's equivalent to the elm_bg_load_size_set() function for bg.
3402     *
3403     * @note this is just a hint, the real size of the pixmap may differ
3404     * depending on the type of image being loaded, being bigger than requested.
3405     *
3406     * @see elm_image_prescale_get()
3407     * @see elm_bg_load_size_set()
3408     *
3409     * @ingroup Image
3410     */
3411    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3412    /**
3413     * Get the prescale size for the image
3414     *
3415     * @param obj The image object
3416     * @return The prescale size
3417     *
3418     * @see elm_image_prescale_set()
3419     *
3420     * @ingroup Image
3421     */
3422    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3423    /**
3424     * Set the image orientation.
3425     *
3426     * @param obj The image object
3427     * @param orient The image orientation
3428     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3429     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3430     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3431     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3432     *  Default is #ELM_IMAGE_ORIENT_NONE.
3433     *
3434     * This function allows to rotate or flip the given image.
3435     *
3436     * @see elm_image_orient_get()
3437     * @see @ref Elm_Image_Orient
3438     *
3439     * @ingroup Image
3440     */
3441    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3442    /**
3443     * Get the image orientation.
3444     *
3445     * @param obj The image object
3446     * @return The image orientation
3447     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3448     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3449     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3450     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3451     *
3452     * @see elm_image_orient_set()
3453     * @see @ref Elm_Image_Orient
3454     *
3455     * @ingroup Image
3456     */
3457    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3458    /**
3459     * Make the image 'editable'.
3460     *
3461     * @param obj Image object.
3462     * @param set Turn on or off editability. Default is @c EINA_FALSE.
3463     *
3464     * This means the image is a valid drag target for drag and drop, and can be
3465     * cut or pasted too.
3466     *
3467     * @ingroup Image
3468     */
3469    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3470    /**
3471     * Make the image 'editable'.
3472     *
3473     * @param obj Image object.
3474     * @return Editability.
3475     *
3476     * This means the image is a valid drag target for drag and drop, and can be
3477     * cut or pasted too.
3478     *
3479     * @ingroup Image
3480     */
3481    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3482    /**
3483     * Get the basic Evas_Image object from this object (widget).
3484     *
3485     * @param obj The image object to get the inlined image from
3486     * @return The inlined image object, or NULL if none exists
3487     *
3488     * This function allows one to get the underlying @c Evas_Object of type
3489     * Image from this elementary widget. It can be useful to do things like get
3490     * the pixel data, save the image to a file, etc.
3491     *
3492     * @note Be careful to not manipulate it, as it is under control of
3493     * elementary.
3494     *
3495     * @ingroup Image
3496     */
3497    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3498    /**
3499     * Set whether the original aspect ratio of the image should be kept on resize.
3500     *
3501     * @param obj The image object.
3502     * @param retained @c EINA_TRUE if the image should retain the aspect,
3503     * @c EINA_FALSE otherwise.
3504     *
3505     * The original aspect ratio (width / height) of the image is usually
3506     * distorted to match the object's size. Enabling this option will retain
3507     * this original aspect, and the way that the image is fit into the object's
3508     * area depends on the option set by elm_image_fill_outside_set().
3509     *
3510     * @see elm_image_aspect_ratio_retained_get()
3511     * @see elm_image_fill_outside_set()
3512     *
3513     * @ingroup Image
3514     */
3515    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3516    /**
3517     * Get if the object retains the original aspect ratio.
3518     *
3519     * @param obj The image object.
3520     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3521     * otherwise.
3522     *
3523     * @ingroup Image
3524     */
3525    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3526
3527    /* smart callbacks called:
3528     * "clicked" - the user clicked the image
3529     */
3530
3531    /**
3532     * @}
3533     */
3534
3535    /* glview */
3536    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3537
3538    typedef enum _Elm_GLView_Mode
3539      {
3540         ELM_GLVIEW_ALPHA   = 1,
3541         ELM_GLVIEW_DEPTH   = 2,
3542         ELM_GLVIEW_STENCIL = 4
3543      } Elm_GLView_Mode;
3544
3545    /**
3546     * Defines a policy for the glview resizing.
3547     *
3548     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3549     */
3550    typedef enum _Elm_GLView_Resize_Policy
3551      {
3552         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
3553         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
3554      } Elm_GLView_Resize_Policy;
3555
3556    typedef enum _Elm_GLView_Render_Policy
3557      {
3558         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
3559         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
3560      } Elm_GLView_Render_Policy;
3561
3562
3563    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3564    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3565    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3566    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3567    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3568    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3569    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3570    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3571    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3572    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3573    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3574    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3575
3576    /* box */
3577    /**
3578     * @defgroup Box Box
3579     *
3580     * @image html img/widget/box/preview-00.png
3581     * @image latex img/widget/box/preview-00.eps width=\textwidth
3582     *
3583     * @image html img/box.png
3584     * @image latex img/box.eps width=\textwidth
3585     *
3586     * A box arranges objects in a linear fashion, governed by a layout function
3587     * that defines the details of this arrangement.
3588     *
3589     * By default, the box will use an internal function to set the layout to
3590     * a single row, either vertical or horizontal. This layout is affected
3591     * by a number of parameters, such as the homogeneous flag set by
3592     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3593     * elm_box_align_set() and the hints set to each object in the box.
3594     *
3595     * For this default layout, it's possible to change the orientation with
3596     * elm_box_horizontal_set(). The box will start in the vertical orientation,
3597     * placing its elements ordered from top to bottom. When horizontal is set,
3598     * the order will go from left to right. If the box is set to be
3599     * homogeneous, every object in it will be assigned the same space, that
3600     * of the largest object. Padding can be used to set some spacing between
3601     * the cell given to each object. The alignment of the box, set with
3602     * elm_box_align_set(), determines how the bounding box of all the elements
3603     * will be placed within the space given to the box widget itself.
3604     *
3605     * The size hints of each object also affect how they are placed and sized
3606     * within the box. evas_object_size_hint_min_set() will give the minimum
3607     * size the object can have, and the box will use it as the basis for all
3608     * latter calculations. Elementary widgets set their own minimum size as
3609     * needed, so there's rarely any need to use it manually.
3610     *
3611     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3612     * used to tell whether the object will be allocated the minimum size it
3613     * needs or if the space given to it should be expanded. It's important
3614     * to realize that expanding the size given to the object is not the same
3615     * thing as resizing the object. It could very well end being a small
3616     * widget floating in a much larger empty space. If not set, the weight
3617     * for objects will normally be 0.0 for both axis, meaning the widget will
3618     * not be expanded. To take as much space possible, set the weight to
3619     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3620     *
3621     * Besides how much space each object is allocated, it's possible to control
3622     * how the widget will be placed within that space using
3623     * evas_object_size_hint_align_set(). By default, this value will be 0.5
3624     * for both axis, meaning the object will be centered, but any value from
3625     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3626     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3627     * is -1.0, means the object will be resized to fill the entire space it
3628     * was allocated.
3629     *
3630     * In addition, customized functions to define the layout can be set, which
3631     * allow the application developer to organize the objects within the box
3632     * in any number of ways.
3633     *
3634     * The special elm_box_layout_transition() function can be used
3635     * to switch from one layout to another, animating the motion of the
3636     * children of the box.
3637     *
3638     * @note Objects should not be added to box objects using _add() calls.
3639     *
3640     * Some examples on how to use boxes follow:
3641     * @li @ref box_example_01
3642     * @li @ref box_example_02
3643     *
3644     * @{
3645     */
3646    /**
3647     * @typedef Elm_Box_Transition
3648     *
3649     * Opaque handler containing the parameters to perform an animated
3650     * transition of the layout the box uses.
3651     *
3652     * @see elm_box_transition_new()
3653     * @see elm_box_layout_set()
3654     * @see elm_box_layout_transition()
3655     */
3656    typedef struct _Elm_Box_Transition Elm_Box_Transition;
3657
3658    /**
3659     * Add a new box to the parent
3660     *
3661     * By default, the box will be in vertical mode and non-homogeneous.
3662     *
3663     * @param parent The parent object
3664     * @return The new object or NULL if it cannot be created
3665     */
3666    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3667    /**
3668     * Set the horizontal orientation
3669     *
3670     * By default, box object arranges their contents vertically from top to
3671     * bottom.
3672     * By calling this function with @p horizontal as EINA_TRUE, the box will
3673     * become horizontal, arranging contents from left to right.
3674     *
3675     * @note This flag is ignored if a custom layout function is set.
3676     *
3677     * @param obj The box object
3678     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3679     * EINA_FALSE = vertical)
3680     */
3681    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3682    /**
3683     * Get the horizontal orientation
3684     *
3685     * @param obj The box object
3686     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3687     */
3688    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3689    /**
3690     * Set the box to arrange its children homogeneously
3691     *
3692     * If enabled, homogeneous layout makes all items the same size, according
3693     * to the size of the largest of its children.
3694     *
3695     * @note This flag is ignored if a custom layout function is set.
3696     *
3697     * @param obj The box object
3698     * @param homogeneous The homogeneous flag
3699     */
3700    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3701    /**
3702     * Get whether the box is using homogeneous mode or not
3703     *
3704     * @param obj The box object
3705     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3706     */
3707    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3708    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3709    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3710    /**
3711     * Add an object to the beginning of the pack list
3712     *
3713     * Pack @p subobj into the box @p obj, placing it first in the list of
3714     * children objects. The actual position the object will get on screen
3715     * depends on the layout used. If no custom layout is set, it will be at
3716     * the top or left, depending if the box is vertical or horizontal,
3717     * respectively.
3718     *
3719     * @param obj The box object
3720     * @param subobj The object to add to the box
3721     *
3722     * @see elm_box_pack_end()
3723     * @see elm_box_pack_before()
3724     * @see elm_box_pack_after()
3725     * @see elm_box_unpack()
3726     * @see elm_box_unpack_all()
3727     * @see elm_box_clear()
3728     */
3729    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3730    /**
3731     * Add an object at the end of the pack list
3732     *
3733     * Pack @p subobj into the box @p obj, placing it last in the list of
3734     * children objects. The actual position the object will get on screen
3735     * depends on the layout used. If no custom layout is set, it will be at
3736     * the bottom or right, depending if the box is vertical or horizontal,
3737     * respectively.
3738     *
3739     * @param obj The box object
3740     * @param subobj The object to add to the box
3741     *
3742     * @see elm_box_pack_start()
3743     * @see elm_box_pack_before()
3744     * @see elm_box_pack_after()
3745     * @see elm_box_unpack()
3746     * @see elm_box_unpack_all()
3747     * @see elm_box_clear()
3748     */
3749    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3750    /**
3751     * Adds an object to the box before the indicated object
3752     *
3753     * This will add the @p subobj to the box indicated before the object
3754     * indicated with @p before. If @p before is not already in the box, results
3755     * are undefined. Before means either to the left of the indicated object or
3756     * above it depending on orientation.
3757     *
3758     * @param obj The box object
3759     * @param subobj The object to add to the box
3760     * @param before The object before which to add it
3761     *
3762     * @see elm_box_pack_start()
3763     * @see elm_box_pack_end()
3764     * @see elm_box_pack_after()
3765     * @see elm_box_unpack()
3766     * @see elm_box_unpack_all()
3767     * @see elm_box_clear()
3768     */
3769    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3770    /**
3771     * Adds an object to the box after the indicated object
3772     *
3773     * This will add the @p subobj to the box indicated after the object
3774     * indicated with @p after. If @p after is not already in the box, results
3775     * are undefined. After means either to the right of the indicated object or
3776     * below it depending on orientation.
3777     *
3778     * @param obj The box object
3779     * @param subobj The object to add to the box
3780     * @param after The object after which to add it
3781     *
3782     * @see elm_box_pack_start()
3783     * @see elm_box_pack_end()
3784     * @see elm_box_pack_before()
3785     * @see elm_box_unpack()
3786     * @see elm_box_unpack_all()
3787     * @see elm_box_clear()
3788     */
3789    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3790    /**
3791     * Clear the box of all children
3792     *
3793     * Remove all the elements contained by the box, deleting the respective
3794     * objects.
3795     *
3796     * @param obj The box object
3797     *
3798     * @see elm_box_unpack()
3799     * @see elm_box_unpack_all()
3800     */
3801    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3802    /**
3803     * Unpack a box item
3804     *
3805     * Remove the object given by @p subobj from the box @p obj without
3806     * deleting it.
3807     *
3808     * @param obj The box object
3809     *
3810     * @see elm_box_unpack_all()
3811     * @see elm_box_clear()
3812     */
3813    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3814    /**
3815     * Remove all items from the box, without deleting them
3816     *
3817     * Clear the box from all children, but don't delete the respective objects.
3818     * If no other references of the box children exist, the objects will never
3819     * be deleted, and thus the application will leak the memory. Make sure
3820     * when using this function that you hold a reference to all the objects
3821     * in the box @p obj.
3822     *
3823     * @param obj The box object
3824     *
3825     * @see elm_box_clear()
3826     * @see elm_box_unpack()
3827     */
3828    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3829    /**
3830     * Retrieve a list of the objects packed into the box
3831     *
3832     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3833     * The order of the list corresponds to the packing order the box uses.
3834     *
3835     * You must free this list with eina_list_free() once you are done with it.
3836     *
3837     * @param obj The box object
3838     */
3839    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3840    /**
3841     * Set the space (padding) between the box's elements.
3842     *
3843     * Extra space in pixels that will be added between a box child and its
3844     * neighbors after its containing cell has been calculated. This padding
3845     * is set for all elements in the box, besides any possible padding that
3846     * individual elements may have through their size hints.
3847     *
3848     * @param obj The box object
3849     * @param horizontal The horizontal space between elements
3850     * @param vertical The vertical space between elements
3851     */
3852    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3853    /**
3854     * Get the space (padding) between the box's elements.
3855     *
3856     * @param obj The box object
3857     * @param horizontal The horizontal space between elements
3858     * @param vertical The vertical space between elements
3859     *
3860     * @see elm_box_padding_set()
3861     */
3862    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3863    /**
3864     * Set the alignment of the whole bouding box of contents.
3865     *
3866     * Sets how the bounding box containing all the elements of the box, after
3867     * their sizes and position has been calculated, will be aligned within
3868     * the space given for the whole box widget.
3869     *
3870     * @param obj The box object
3871     * @param horizontal The horizontal alignment of elements
3872     * @param vertical The vertical alignment of elements
3873     */
3874    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
3875    /**
3876     * Get the alignment of the whole bouding box of contents.
3877     *
3878     * @param obj The box object
3879     * @param horizontal The horizontal alignment of elements
3880     * @param vertical The vertical alignment of elements
3881     *
3882     * @see elm_box_align_set()
3883     */
3884    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
3885
3886    /**
3887     * Set the layout defining function to be used by the box
3888     *
3889     * Whenever anything changes that requires the box in @p obj to recalculate
3890     * the size and position of its elements, the function @p cb will be called
3891     * to determine what the layout of the children will be.
3892     *
3893     * Once a custom function is set, everything about the children layout
3894     * is defined by it. The flags set by elm_box_horizontal_set() and
3895     * elm_box_homogeneous_set() no longer have any meaning, and the values
3896     * given by elm_box_padding_set() and elm_box_align_set() are up to this
3897     * layout function to decide if they are used and how. These last two
3898     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
3899     * passed to @p cb. The @c Evas_Object the function receives is not the
3900     * Elementary widget, but the internal Evas Box it uses, so none of the
3901     * functions described here can be used on it.
3902     *
3903     * Any of the layout functions in @c Evas can be used here, as well as the
3904     * special elm_box_layout_transition().
3905     *
3906     * The final @p data argument received by @p cb is the same @p data passed
3907     * here, and the @p free_data function will be called to free it
3908     * whenever the box is destroyed or another layout function is set.
3909     *
3910     * Setting @p cb to NULL will revert back to the default layout function.
3911     *
3912     * @param obj The box object
3913     * @param cb The callback function used for layout
3914     * @param data Data that will be passed to layout function
3915     * @param free_data Function called to free @p data
3916     *
3917     * @see elm_box_layout_transition()
3918     */
3919    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);
3920    /**
3921     * Special layout function that animates the transition from one layout to another
3922     *
3923     * Normally, when switching the layout function for a box, this will be
3924     * reflected immediately on screen on the next render, but it's also
3925     * possible to do this through an animated transition.
3926     *
3927     * This is done by creating an ::Elm_Box_Transition and setting the box
3928     * layout to this function.
3929     *
3930     * For example:
3931     * @code
3932     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
3933     *                            evas_object_box_layout_vertical, // start
3934     *                            NULL, // data for initial layout
3935     *                            NULL, // free function for initial data
3936     *                            evas_object_box_layout_horizontal, // end
3937     *                            NULL, // data for final layout
3938     *                            NULL, // free function for final data
3939     *                            anim_end, // will be called when animation ends
3940     *                            NULL); // data for anim_end function\
3941     * elm_box_layout_set(box, elm_box_layout_transition, t,
3942     *                    elm_box_transition_free);
3943     * @endcode
3944     *
3945     * @note This function can only be used with elm_box_layout_set(). Calling
3946     * it directly will not have the expected results.
3947     *
3948     * @see elm_box_transition_new
3949     * @see elm_box_transition_free
3950     * @see elm_box_layout_set
3951     */
3952    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3953    /**
3954     * Create a new ::Elm_Box_Transition to animate the switch of layouts
3955     *
3956     * If you want to animate the change from one layout to another, you need
3957     * to set the layout function of the box to elm_box_layout_transition(),
3958     * passing as user data to it an instance of ::Elm_Box_Transition with the
3959     * necessary information to perform this animation. The free function to
3960     * set for the layout is elm_box_transition_free().
3961     *
3962     * The parameters to create an ::Elm_Box_Transition sum up to how long
3963     * will it be, in seconds, a layout function to describe the initial point,
3964     * another for the final position of the children and one function to be
3965     * called when the whole animation ends. This last function is useful to
3966     * set the definitive layout for the box, usually the same as the end
3967     * layout for the animation, but could be used to start another transition.
3968     *
3969     * @param start_layout The layout function that will be used to start the animation
3970     * @param start_layout_data The data to be passed the @p start_layout function
3971     * @param start_layout_free_data Function to free @p start_layout_data
3972     * @param end_layout The layout function that will be used to end the animation
3973     * @param end_layout_free_data The data to be passed the @p end_layout function
3974     * @param end_layout_free_data Function to free @p end_layout_data
3975     * @param transition_end_cb Callback function called when animation ends
3976     * @param transition_end_data Data to be passed to @p transition_end_cb
3977     * @return An instance of ::Elm_Box_Transition
3978     *
3979     * @see elm_box_transition_new
3980     * @see elm_box_layout_transition
3981     */
3982    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);
3983    /**
3984     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3985     *
3986     * This function is mostly useful as the @c free_data parameter in
3987     * elm_box_layout_set() when elm_box_layout_transition().
3988     *
3989     * @param data The Elm_Box_Transition instance to be freed.
3990     *
3991     * @see elm_box_transition_new
3992     * @see elm_box_layout_transition
3993     */
3994    EAPI void                elm_box_transition_free(void *data);
3995    /**
3996     * @}
3997     */
3998
3999    /* button */
4000    /**
4001     * @defgroup Button Button
4002     *
4003     * @image html img/widget/button/preview-00.png
4004     * @image latex img/widget/button/preview-00.eps
4005     * @image html img/widget/button/preview-01.png
4006     * @image latex img/widget/button/preview-01.eps
4007     * @image html img/widget/button/preview-02.png
4008     * @image latex img/widget/button/preview-02.eps
4009     *
4010     * This is a push-button. Press it and run some function. It can contain
4011     * a simple label and icon object and it also has an autorepeat feature.
4012     *
4013     * This widgets emits the following signals:
4014     * @li "clicked": the user clicked the button (press/release).
4015     * @li "repeated": the user pressed the button without releasing it.
4016     * @li "pressed": button was pressed.
4017     * @li "unpressed": button was released after being pressed.
4018     * In all three cases, the @c event parameter of the callback will be
4019     * @c NULL.
4020     *
4021     * Also, defined in the default theme, the button has the following styles
4022     * available:
4023     * @li default: a normal button.
4024     * @li anchor: Like default, but the button fades away when the mouse is not
4025     * over it, leaving only the text or icon.
4026     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4027     * continuous look across its options.
4028     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4029     *
4030     * Follow through a complete example @ref button_example_01 "here".
4031     * @{
4032     */
4033    /**
4034     * Add a new button to the parent's canvas
4035     *
4036     * @param parent The parent object
4037     * @return The new object or NULL if it cannot be created
4038     */
4039    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4040    /**
4041     * Set the label used in the button
4042     *
4043     * The passed @p label can be NULL to clean any existing text in it and
4044     * leave the button as an icon only object.
4045     *
4046     * @param obj The button object
4047     * @param label The text will be written on the button
4048     * @deprecated use elm_object_text_set() instead.
4049     */
4050    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4051    /**
4052     * Get the label set for the button
4053     *
4054     * The string returned is an internal pointer and should not be freed or
4055     * altered. It will also become invalid when the button is destroyed.
4056     * The string returned, if not NULL, is a stringshare, so if you need to
4057     * keep it around even after the button is destroyed, you can use
4058     * eina_stringshare_ref().
4059     *
4060     * @param obj The button object
4061     * @return The text set to the label, or NULL if nothing is set
4062     * @deprecated use elm_object_text_set() instead.
4063     */
4064    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4065    /**
4066     * Set the icon used for the button
4067     *
4068     * Setting a new icon will delete any other that was previously set, making
4069     * any reference to them invalid. If you need to maintain the previous
4070     * object alive, unset it first with elm_button_icon_unset().
4071     *
4072     * @param obj The button object
4073     * @param icon The icon object for the button
4074     */
4075    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4076    /**
4077     * Get the icon used for the button
4078     *
4079     * Return the icon object which is set for this widget. If the button is
4080     * destroyed or another icon is set, the returned object will be deleted
4081     * and any reference to it will be invalid.
4082     *
4083     * @param obj The button object
4084     * @return The icon object that is being used
4085     *
4086     * @see elm_button_icon_unset()
4087     */
4088    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4089    /**
4090     * Remove the icon set without deleting it and return the object
4091     *
4092     * This function drops the reference the button holds of the icon object
4093     * and returns this last object. It is used in case you want to remove any
4094     * icon, or set another one, without deleting the actual object. The button
4095     * will be left without an icon set.
4096     *
4097     * @param obj The button object
4098     * @return The icon object that was being used
4099     */
4100    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4101    /**
4102     * Turn on/off the autorepeat event generated when the button is kept pressed
4103     *
4104     * When off, no autorepeat is performed and buttons emit a normal @c clicked
4105     * signal when they are clicked.
4106     *
4107     * When on, keeping a button pressed will continuously emit a @c repeated
4108     * signal until the button is released. The time it takes until it starts
4109     * emitting the signal is given by
4110     * elm_button_autorepeat_initial_timeout_set(), and the time between each
4111     * new emission by elm_button_autorepeat_gap_timeout_set().
4112     *
4113     * @param obj The button object
4114     * @param on  A bool to turn on/off the event
4115     */
4116    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4117    /**
4118     * Get whether the autorepeat feature is enabled
4119     *
4120     * @param obj The button object
4121     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4122     *
4123     * @see elm_button_autorepeat_set()
4124     */
4125    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4126    /**
4127     * Set the initial timeout before the autorepeat event is generated
4128     *
4129     * Sets the timeout, in seconds, since the button is pressed until the
4130     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4131     * won't be any delay and the even will be fired the moment the button is
4132     * pressed.
4133     *
4134     * @param obj The button object
4135     * @param t   Timeout in seconds
4136     *
4137     * @see elm_button_autorepeat_set()
4138     * @see elm_button_autorepeat_gap_timeout_set()
4139     */
4140    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4141    /**
4142     * Get the initial timeout before the autorepeat event is generated
4143     *
4144     * @param obj The button object
4145     * @return Timeout in seconds
4146     *
4147     * @see elm_button_autorepeat_initial_timeout_set()
4148     */
4149    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4150    /**
4151     * Set the interval between each generated autorepeat event
4152     *
4153     * After the first @c repeated event is fired, all subsequent ones will
4154     * follow after a delay of @p t seconds for each.
4155     *
4156     * @param obj The button object
4157     * @param t   Interval in seconds
4158     *
4159     * @see elm_button_autorepeat_initial_timeout_set()
4160     */
4161    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4162    /**
4163     * Get the interval between each generated autorepeat event
4164     *
4165     * @param obj The button object
4166     * @return Interval in seconds
4167     */
4168    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4169    /**
4170     * @}
4171     */
4172
4173    /**
4174     * @defgroup File_Selector_Button File Selector Button
4175     *
4176     * @image html img/widget/fileselector_button/preview-00.png
4177     * @image latex img/widget/fileselector_button/preview-00.eps
4178     * @image html img/widget/fileselector_button/preview-01.png
4179     * @image latex img/widget/fileselector_button/preview-01.eps
4180     * @image html img/widget/fileselector_button/preview-02.png
4181     * @image latex img/widget/fileselector_button/preview-02.eps
4182     *
4183     * This is a button that, when clicked, creates an Elementary
4184     * window (or inner window) <b> with a @ref Fileselector "file
4185     * selector widget" within</b>. When a file is chosen, the (inner)
4186     * window is closed and the button emits a signal having the
4187     * selected file as it's @c event_info.
4188     *
4189     * This widget encapsulates operations on its internal file
4190     * selector on its own API. There is less control over its file
4191     * selector than that one would have instatiating one directly.
4192     *
4193     * The following styles are available for this button:
4194     * @li @c "default"
4195     * @li @c "anchor"
4196     * @li @c "hoversel_vertical"
4197     * @li @c "hoversel_vertical_entry"
4198     *
4199     * Smart callbacks one can register to:
4200     * - @c "file,chosen" - the user has selected a path, whose string
4201     *   pointer comes as the @c event_info data (a stringshared
4202     *   string)
4203     *
4204     * Here is an example on its usage:
4205     * @li @ref fileselector_button_example
4206     *
4207     * @see @ref File_Selector_Entry for a similar widget.
4208     * @{
4209     */
4210
4211    /**
4212     * Add a new file selector button widget to the given parent
4213     * Elementary (container) object
4214     *
4215     * @param parent The parent object
4216     * @return a new file selector button widget handle or @c NULL, on
4217     * errors
4218     */
4219    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4220
4221    /**
4222     * Set the label for a given file selector button widget
4223     *
4224     * @param obj The file selector button widget
4225     * @param label The text label to be displayed on @p obj
4226     *
4227     * @deprecated use elm_object_text_set() instead.
4228     */
4229    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4230
4231    /**
4232     * Get the label set for a given file selector button widget
4233     *
4234     * @param obj The file selector button widget
4235     * @return The button label
4236     *
4237     * @deprecated use elm_object_text_set() instead.
4238     */
4239    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4240
4241    /**
4242     * Set the icon on a given file selector button widget
4243     *
4244     * @param obj The file selector button widget
4245     * @param icon The icon object for the button
4246     *
4247     * Once the icon object is set, a previously set one will be
4248     * deleted. If you want to keep the latter, use the
4249     * elm_fileselector_button_icon_unset() function.
4250     *
4251     * @see elm_fileselector_button_icon_get()
4252     */
4253    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4254
4255    /**
4256     * Get the icon set for a given file selector button widget
4257     *
4258     * @param obj The file selector button widget
4259     * @return The icon object currently set on @p obj or @c NULL, if
4260     * none is
4261     *
4262     * @see elm_fileselector_button_icon_set()
4263     */
4264    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4265
4266    /**
4267     * Unset the icon used in a given file selector button widget
4268     *
4269     * @param obj The file selector button widget
4270     * @return The icon object that was being used on @p obj or @c
4271     * NULL, on errors
4272     *
4273     * Unparent and return the icon object which was set for this
4274     * widget.
4275     *
4276     * @see elm_fileselector_button_icon_set()
4277     */
4278    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4279
4280    /**
4281     * Set the title for a given file selector button widget's window
4282     *
4283     * @param obj The file selector button widget
4284     * @param title The title string
4285     *
4286     * This will change the window's title, when the file selector pops
4287     * out after a click on the button. Those windows have the default
4288     * (unlocalized) value of @c "Select a file" as titles.
4289     *
4290     * @note It will only take any effect if the file selector
4291     * button widget is @b not under "inwin mode".
4292     *
4293     * @see elm_fileselector_button_window_title_get()
4294     */
4295    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4296
4297    /**
4298     * Get the title set for a given file selector button widget's
4299     * window
4300     *
4301     * @param obj The file selector button widget
4302     * @return Title of the file selector button's window
4303     *
4304     * @see elm_fileselector_button_window_title_get() for more details
4305     */
4306    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4307
4308    /**
4309     * Set the size of a given file selector button widget's window,
4310     * holding the file selector itself.
4311     *
4312     * @param obj The file selector button widget
4313     * @param width The window's width
4314     * @param height The window's height
4315     *
4316     * @note it will only take any effect if the file selector button
4317     * widget is @b not under "inwin mode". The default size for the
4318     * window (when applicable) is 400x400 pixels.
4319     *
4320     * @see elm_fileselector_button_window_size_get()
4321     */
4322    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4323
4324    /**
4325     * Get the size of a given file selector button widget's window,
4326     * holding the file selector itself.
4327     *
4328     * @param obj The file selector button widget
4329     * @param width Pointer into which to store the width value
4330     * @param height Pointer into which to store the height value
4331     *
4332     * @note Use @c NULL pointers on the size values you're not
4333     * interested in: they'll be ignored by the function.
4334     *
4335     * @see elm_fileselector_button_window_size_set(), for more details
4336     */
4337    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4338
4339    /**
4340     * Set the initial file system path for a given file selector
4341     * button widget
4342     *
4343     * @param obj The file selector button widget
4344     * @param path The path string
4345     *
4346     * It must be a <b>directory</b> path, which will have the contents
4347     * displayed initially in the file selector's view, when invoked
4348     * from @p obj. The default initial path is the @c "HOME"
4349     * environment variable's value.
4350     *
4351     * @see elm_fileselector_button_path_get()
4352     */
4353    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4354
4355    /**
4356     * Get the initial file system path set for a given file selector
4357     * button widget
4358     *
4359     * @param obj The file selector button widget
4360     * @return path The path string
4361     *
4362     * @see elm_fileselector_button_path_set() for more details
4363     */
4364    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4365
4366    /**
4367     * Enable/disable a tree view in the given file selector button
4368     * widget's internal file selector
4369     *
4370     * @param obj The file selector button widget
4371     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4372     * disable
4373     *
4374     * This has the same effect as elm_fileselector_expandable_set(),
4375     * but now applied to a file selector button's internal file
4376     * selector.
4377     *
4378     * @note There's no way to put a file selector button's internal
4379     * file selector in "grid mode", as one may do with "pure" file
4380     * selectors.
4381     *
4382     * @see elm_fileselector_expandable_get()
4383     */
4384    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4385
4386    /**
4387     * Get whether tree view is enabled for the given file selector
4388     * button widget's internal file selector
4389     *
4390     * @param obj The file selector button widget
4391     * @return @c EINA_TRUE if @p obj widget's internal file selector
4392     * is in tree view, @c EINA_FALSE otherwise (and or errors)
4393     *
4394     * @see elm_fileselector_expandable_set() for more details
4395     */
4396    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4397
4398    /**
4399     * Set whether a given file selector button widget's internal file
4400     * selector is to display folders only or the directory contents,
4401     * as well.
4402     *
4403     * @param obj The file selector button widget
4404     * @param only @c EINA_TRUE to make @p obj widget's internal file
4405     * selector only display directories, @c EINA_FALSE to make files
4406     * to be displayed in it too
4407     *
4408     * This has the same effect as elm_fileselector_folder_only_set(),
4409     * but now applied to a file selector button's internal file
4410     * selector.
4411     *
4412     * @see elm_fileselector_folder_only_get()
4413     */
4414    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4415
4416    /**
4417     * Get whether a given file selector button widget's internal file
4418     * selector is displaying folders only or the directory contents,
4419     * as well.
4420     *
4421     * @param obj The file selector button widget
4422     * @return @c EINA_TRUE if @p obj widget's internal file
4423     * selector is only displaying directories, @c EINA_FALSE if files
4424     * are being displayed in it too (and on errors)
4425     *
4426     * @see elm_fileselector_button_folder_only_set() for more details
4427     */
4428    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4429
4430    /**
4431     * Enable/disable the file name entry box where the user can type
4432     * in a name for a file, in a given file selector button widget's
4433     * internal file selector.
4434     *
4435     * @param obj The file selector button widget
4436     * @param is_save @c EINA_TRUE to make @p obj widget's internal
4437     * file selector a "saving dialog", @c EINA_FALSE otherwise
4438     *
4439     * This has the same effect as elm_fileselector_is_save_set(),
4440     * but now applied to a file selector button's internal file
4441     * selector.
4442     *
4443     * @see elm_fileselector_is_save_get()
4444     */
4445    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4446
4447    /**
4448     * Get whether the given file selector button widget's internal
4449     * file selector is in "saving dialog" mode
4450     *
4451     * @param obj The file selector button widget
4452     * @return @c EINA_TRUE, if @p obj widget's internal file selector
4453     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4454     * errors)
4455     *
4456     * @see elm_fileselector_button_is_save_set() for more details
4457     */
4458    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4459
4460    /**
4461     * Set whether a given file selector button widget's internal file
4462     * selector will raise an Elementary "inner window", instead of a
4463     * dedicated Elementary window. By default, it won't.
4464     *
4465     * @param obj The file selector button widget
4466     * @param value @c EINA_TRUE to make it use an inner window, @c
4467     * EINA_TRUE to make it use a dedicated window
4468     *
4469     * @see elm_win_inwin_add() for more information on inner windows
4470     * @see elm_fileselector_button_inwin_mode_get()
4471     */
4472    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4473
4474    /**
4475     * Get whether a given file selector button widget's internal file
4476     * selector will raise an Elementary "inner window", instead of a
4477     * dedicated Elementary window.
4478     *
4479     * @param obj The file selector button widget
4480     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4481     * if it will use a dedicated window
4482     *
4483     * @see elm_fileselector_button_inwin_mode_set() for more details
4484     */
4485    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4486
4487    /**
4488     * @}
4489     */
4490
4491     /**
4492     * @defgroup File_Selector_Entry File Selector Entry
4493     *
4494     * @image html img/widget/fileselector_entry/preview-00.png
4495     * @image latex img/widget/fileselector_entry/preview-00.eps
4496     *
4497     * This is an entry made to be filled with or display a <b>file
4498     * system path string</b>. Besides the entry itself, the widget has
4499     * a @ref File_Selector_Button "file selector button" on its side,
4500     * which will raise an internal @ref Fileselector "file selector widget",
4501     * when clicked, for path selection aided by file system
4502     * navigation.
4503     *
4504     * This file selector may appear in an Elementary window or in an
4505     * inner window. When a file is chosen from it, the (inner) window
4506     * is closed and the selected file's path string is exposed both as
4507     * an smart event and as the new text on the entry.
4508     *
4509     * This widget encapsulates operations on its internal file
4510     * selector on its own API. There is less control over its file
4511     * selector than that one would have instatiating one directly.
4512     *
4513     * Smart callbacks one can register to:
4514     * - @c "changed" - The text within the entry was changed
4515     * - @c "activated" - The entry has had editing finished and
4516     *   changes are to be "committed"
4517     * - @c "press" - The entry has been clicked
4518     * - @c "longpressed" - The entry has been clicked (and held) for a
4519     *   couple seconds
4520     * - @c "clicked" - The entry has been clicked
4521     * - @c "clicked,double" - The entry has been double clicked
4522     * - @c "focused" - The entry has received focus
4523     * - @c "unfocused" - The entry has lost focus
4524     * - @c "selection,paste" - A paste action has occurred on the
4525     *   entry
4526     * - @c "selection,copy" - A copy action has occurred on the entry
4527     * - @c "selection,cut" - A cut action has occurred on the entry
4528     * - @c "unpressed" - The file selector entry's button was released
4529     *   after being pressed.
4530     * - @c "file,chosen" - The user has selected a path via the file
4531     *   selector entry's internal file selector, whose string pointer
4532     *   comes as the @c event_info data (a stringshared string)
4533     *
4534     * Here is an example on its usage:
4535     * @li @ref fileselector_entry_example
4536     *
4537     * @see @ref File_Selector_Button for a similar widget.
4538     * @{
4539     */
4540
4541    /**
4542     * Add a new file selector entry widget to the given parent
4543     * Elementary (container) object
4544     *
4545     * @param parent The parent object
4546     * @return a new file selector entry widget handle or @c NULL, on
4547     * errors
4548     */
4549    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4550
4551    /**
4552     * Set the label for a given file selector entry widget's button
4553     *
4554     * @param obj The file selector entry widget
4555     * @param label The text label to be displayed on @p obj widget's
4556     * button
4557     *
4558     * @deprecated use elm_object_text_set() instead.
4559     */
4560    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4561
4562    /**
4563     * Get the label set for a given file selector entry widget's button
4564     *
4565     * @param obj The file selector entry widget
4566     * @return The widget button's label
4567     *
4568     * @deprecated use elm_object_text_set() instead.
4569     */
4570    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4571
4572    /**
4573     * Set the icon on a given file selector entry widget's button
4574     *
4575     * @param obj The file selector entry widget
4576     * @param icon The icon object for the entry's button
4577     *
4578     * Once the icon object is set, a previously set one will be
4579     * deleted. If you want to keep the latter, use the
4580     * elm_fileselector_entry_button_icon_unset() function.
4581     *
4582     * @see elm_fileselector_entry_button_icon_get()
4583     */
4584    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4585
4586    /**
4587     * Get the icon set for a given file selector entry widget's button
4588     *
4589     * @param obj The file selector entry widget
4590     * @return The icon object currently set on @p obj widget's button
4591     * or @c NULL, if none is
4592     *
4593     * @see elm_fileselector_entry_button_icon_set()
4594     */
4595    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4596
4597    /**
4598     * Unset the icon used in a given file selector entry widget's
4599     * button
4600     *
4601     * @param obj The file selector entry widget
4602     * @return The icon object that was being used on @p obj widget's
4603     * button or @c NULL, on errors
4604     *
4605     * Unparent and return the icon object which was set for this
4606     * widget's button.
4607     *
4608     * @see elm_fileselector_entry_button_icon_set()
4609     */
4610    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4611
4612    /**
4613     * Set the title for a given file selector entry widget's window
4614     *
4615     * @param obj The file selector entry widget
4616     * @param title The title string
4617     *
4618     * This will change the window's title, when the file selector pops
4619     * out after a click on the entry's button. Those windows have the
4620     * default (unlocalized) value of @c "Select a file" as titles.
4621     *
4622     * @note It will only take any effect if the file selector
4623     * entry widget is @b not under "inwin mode".
4624     *
4625     * @see elm_fileselector_entry_window_title_get()
4626     */
4627    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4628
4629    /**
4630     * Get the title set for a given file selector entry widget's
4631     * window
4632     *
4633     * @param obj The file selector entry widget
4634     * @return Title of the file selector entry's window
4635     *
4636     * @see elm_fileselector_entry_window_title_get() for more details
4637     */
4638    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4639
4640    /**
4641     * Set the size of a given file selector entry widget's window,
4642     * holding the file selector itself.
4643     *
4644     * @param obj The file selector entry widget
4645     * @param width The window's width
4646     * @param height The window's height
4647     *
4648     * @note it will only take any effect if the file selector entry
4649     * widget is @b not under "inwin mode". The default size for the
4650     * window (when applicable) is 400x400 pixels.
4651     *
4652     * @see elm_fileselector_entry_window_size_get()
4653     */
4654    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4655
4656    /**
4657     * Get the size of a given file selector entry widget's window,
4658     * holding the file selector itself.
4659     *
4660     * @param obj The file selector entry widget
4661     * @param width Pointer into which to store the width value
4662     * @param height Pointer into which to store the height value
4663     *
4664     * @note Use @c NULL pointers on the size values you're not
4665     * interested in: they'll be ignored by the function.
4666     *
4667     * @see elm_fileselector_entry_window_size_set(), for more details
4668     */
4669    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4670
4671    /**
4672     * Set the initial file system path and the entry's path string for
4673     * a given file selector entry widget
4674     *
4675     * @param obj The file selector entry widget
4676     * @param path The path string
4677     *
4678     * It must be a <b>directory</b> path, which will have the contents
4679     * displayed initially in the file selector's view, when invoked
4680     * from @p obj. The default initial path is the @c "HOME"
4681     * environment variable's value.
4682     *
4683     * @see elm_fileselector_entry_path_get()
4684     */
4685    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4686
4687    /**
4688     * Get the entry's path string for a given file selector entry
4689     * widget
4690     *
4691     * @param obj The file selector entry widget
4692     * @return path The path string
4693     *
4694     * @see elm_fileselector_entry_path_set() for more details
4695     */
4696    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4697
4698    /**
4699     * Enable/disable a tree view in the given file selector entry
4700     * widget's internal file selector
4701     *
4702     * @param obj The file selector entry widget
4703     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4704     * disable
4705     *
4706     * This has the same effect as elm_fileselector_expandable_set(),
4707     * but now applied to a file selector entry's internal file
4708     * selector.
4709     *
4710     * @note There's no way to put a file selector entry's internal
4711     * file selector in "grid mode", as one may do with "pure" file
4712     * selectors.
4713     *
4714     * @see elm_fileselector_expandable_get()
4715     */
4716    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4717
4718    /**
4719     * Get whether tree view is enabled for the given file selector
4720     * entry widget's internal file selector
4721     *
4722     * @param obj The file selector entry widget
4723     * @return @c EINA_TRUE if @p obj widget's internal file selector
4724     * is in tree view, @c EINA_FALSE otherwise (and or errors)
4725     *
4726     * @see elm_fileselector_expandable_set() for more details
4727     */
4728    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4729
4730    /**
4731     * Set whether a given file selector entry widget's internal file
4732     * selector is to display folders only or the directory contents,
4733     * as well.
4734     *
4735     * @param obj The file selector entry widget
4736     * @param only @c EINA_TRUE to make @p obj widget's internal file
4737     * selector only display directories, @c EINA_FALSE to make files
4738     * to be displayed in it too
4739     *
4740     * This has the same effect as elm_fileselector_folder_only_set(),
4741     * but now applied to a file selector entry's internal file
4742     * selector.
4743     *
4744     * @see elm_fileselector_folder_only_get()
4745     */
4746    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4747
4748    /**
4749     * Get whether a given file selector entry widget's internal file
4750     * selector is displaying folders only or the directory contents,
4751     * as well.
4752     *
4753     * @param obj The file selector entry widget
4754     * @return @c EINA_TRUE if @p obj widget's internal file
4755     * selector is only displaying directories, @c EINA_FALSE if files
4756     * are being displayed in it too (and on errors)
4757     *
4758     * @see elm_fileselector_entry_folder_only_set() for more details
4759     */
4760    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4761
4762    /**
4763     * Enable/disable the file name entry box where the user can type
4764     * in a name for a file, in a given file selector entry widget's
4765     * internal file selector.
4766     *
4767     * @param obj The file selector entry widget
4768     * @param is_save @c EINA_TRUE to make @p obj widget's internal
4769     * file selector a "saving dialog", @c EINA_FALSE otherwise
4770     *
4771     * This has the same effect as elm_fileselector_is_save_set(),
4772     * but now applied to a file selector entry's internal file
4773     * selector.
4774     *
4775     * @see elm_fileselector_is_save_get()
4776     */
4777    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4778
4779    /**
4780     * Get whether the given file selector entry widget's internal
4781     * file selector is in "saving dialog" mode
4782     *
4783     * @param obj The file selector entry widget
4784     * @return @c EINA_TRUE, if @p obj widget's internal file selector
4785     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4786     * errors)
4787     *
4788     * @see elm_fileselector_entry_is_save_set() for more details
4789     */
4790    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4791
4792    /**
4793     * Set whether a given file selector entry widget's internal file
4794     * selector will raise an Elementary "inner window", instead of a
4795     * dedicated Elementary window. By default, it won't.
4796     *
4797     * @param obj The file selector entry widget
4798     * @param value @c EINA_TRUE to make it use an inner window, @c
4799     * EINA_TRUE to make it use a dedicated window
4800     *
4801     * @see elm_win_inwin_add() for more information on inner windows
4802     * @see elm_fileselector_entry_inwin_mode_get()
4803     */
4804    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4805
4806    /**
4807     * Get whether a given file selector entry widget's internal file
4808     * selector will raise an Elementary "inner window", instead of a
4809     * dedicated Elementary window.
4810     *
4811     * @param obj The file selector entry widget
4812     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4813     * if it will use a dedicated window
4814     *
4815     * @see elm_fileselector_entry_inwin_mode_set() for more details
4816     */
4817    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4818
4819    /**
4820     * Set the initial file system path for a given file selector entry
4821     * widget
4822     *
4823     * @param obj The file selector entry widget
4824     * @param path The path string
4825     *
4826     * It must be a <b>directory</b> path, which will have the contents
4827     * displayed initially in the file selector's view, when invoked
4828     * from @p obj. The default initial path is the @c "HOME"
4829     * environment variable's value.
4830     *
4831     * @see elm_fileselector_entry_path_get()
4832     */
4833    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4834
4835    /**
4836     * Get the parent directory's path to the latest file selection on
4837     * a given filer selector entry widget
4838     *
4839     * @param obj The file selector object
4840     * @return The (full) path of the directory of the last selection
4841     * on @p obj widget, a @b stringshared string
4842     *
4843     * @see elm_fileselector_entry_path_set()
4844     */
4845    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4846
4847    /**
4848     * @}
4849     */
4850
4851    /**
4852     * @defgroup Scroller Scroller
4853     *
4854     * A scroller holds a single object and "scrolls it around". This means that
4855     * it allows the user to use a scrollbar (or a finger) to drag the viewable
4856     * region around, allowing to move through a much larger object that is
4857     * contained in the scroller. The scroiller will always have a small minimum
4858     * size by default as it won't be limited by the contents of the scroller.
4859     *
4860     * Signals that you can add callbacks for are:
4861     * @li "edge,left" - the left edge of the content has been reached
4862     * @li "edge,right" - the right edge of the content has been reached
4863     * @li "edge,top" - the top edge of the content has been reached
4864     * @li "edge,bottom" - the bottom edge of the content has been reached
4865     * @li "scroll" - the content has been scrolled (moved)
4866     * @li "scroll,anim,start" - scrolling animation has started
4867     * @li "scroll,anim,stop" - scrolling animation has stopped
4868     * @li "scroll,drag,start" - dragging the contents around has started
4869     * @li "scroll,drag,stop" - dragging the contents around has stopped
4870     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
4871     * user intervetion.
4872     *
4873     * @note When Elemementary is in embedded mode the scrollbars will not be
4874     * dragable, they appear merely as indicators of how much has been scrolled.
4875     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
4876     * fingerscroll) won't work.
4877     *
4878     * In @ref tutorial_scroller you'll find an example of how to use most of
4879     * this API.
4880     * @{
4881     */
4882    /**
4883     * @brief Type that controls when scrollbars should appear.
4884     *
4885     * @see elm_scroller_policy_set()
4886     */
4887    typedef enum _Elm_Scroller_Policy
4888      {
4889         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
4890         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
4891         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
4892         ELM_SCROLLER_POLICY_LAST
4893      } Elm_Scroller_Policy;
4894    /**
4895     * @brief Add a new scroller to the parent
4896     *
4897     * @param parent The parent object
4898     * @return The new object or NULL if it cannot be created
4899     */
4900    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4901    /**
4902     * @brief Set the content of the scroller widget (the object to be scrolled around).
4903     *
4904     * @param obj The scroller object
4905     * @param content The new content object
4906     *
4907     * Once the content object is set, a previously set one will be deleted.
4908     * If you want to keep that old content object, use the
4909     * elm_scroller_content_unset() function.
4910     */
4911    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
4912    /**
4913     * @brief Get the content of the scroller widget
4914     *
4915     * @param obj The slider object
4916     * @return The content that is being used
4917     *
4918     * Return the content object which is set for this widget
4919     *
4920     * @see elm_scroller_content_set()
4921     */
4922    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4923    /**
4924     * @brief Unset the content of the scroller widget
4925     *
4926     * @param obj The slider object
4927     * @return The content that was being used
4928     *
4929     * Unparent and return the content object which was set for this widget
4930     *
4931     * @see elm_scroller_content_set()
4932     */
4933    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4934    /**
4935     * @brief Set custom theme elements for the scroller
4936     *
4937     * @param obj The scroller object
4938     * @param widget The widget name to use (default is "scroller")
4939     * @param base The base name to use (default is "base")
4940     */
4941    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
4942    /**
4943     * @brief Make the scroller minimum size limited to the minimum size of the content
4944     *
4945     * @param obj The scroller object
4946     * @param w Enable limiting minimum size horizontally
4947     * @param h Enable limiting minimum size vertically
4948     *
4949     * By default the scroller will be as small as its design allows,
4950     * irrespective of its content. This will make the scroller minimum size the
4951     * right size horizontally and/or vertically to perfectly fit its content in
4952     * that direction.
4953     */
4954    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
4955    /**
4956     * @brief Show a specific virtual region within the scroller content object
4957     *
4958     * @param obj The scroller object
4959     * @param x X coordinate of the region
4960     * @param y Y coordinate of the region
4961     * @param w Width of the region
4962     * @param h Height of the region
4963     *
4964     * This will ensure all (or part if it does not fit) of the designated
4965     * region in the virtual content object (0, 0 starting at the top-left of the
4966     * virtual content object) is shown within the scroller.
4967     */
4968    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);
4969    /**
4970     * @brief Set the scrollbar visibility policy
4971     *
4972     * @param obj The scroller object
4973     * @param policy_h Horizontal scrollbar policy
4974     * @param policy_v Vertical scrollbar policy
4975     *
4976     * This sets the scrollbar visibility policy for the given scroller.
4977     * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
4978     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
4979     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
4980     * respectively for the horizontal and vertical scrollbars.
4981     */
4982    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
4983    /**
4984     * @brief Gets scrollbar visibility policy
4985     *
4986     * @param obj The scroller object
4987     * @param policy_h Horizontal scrollbar policy
4988     * @param policy_v Vertical scrollbar policy
4989     *
4990     * @see elm_scroller_policy_set()
4991     */
4992    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
4993    /**
4994     * @brief Get the currently visible content region
4995     *
4996     * @param obj The scroller object
4997     * @param x X coordinate of the region
4998     * @param y Y coordinate of the region
4999     * @param w Width of the region
5000     * @param h Height of the region
5001     *
5002     * This gets the current region in the content object that is visible through
5003     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
5004     * w, @p h values pointed to.
5005     *
5006     * @note All coordinates are relative to the content.
5007     *
5008     * @see elm_scroller_region_show()
5009     */
5010    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);
5011    /**
5012     * @brief Get the size of the content object
5013     *
5014     * @param obj The scroller object
5015     * @param w Width return
5016     * @param h Height return
5017     *
5018     * This gets the size of the content object of the scroller.
5019     */
5020    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5021    /**
5022     * @brief Set bouncing behavior
5023     *
5024     * @param obj The scroller object
5025     * @param h_bounce Will the scroller bounce horizontally or not
5026     * @param v_bounce Will the scroller bounce vertically or not
5027     *
5028     * When scrolling, the scroller may "bounce" when reaching an edge of the
5029     * content object. This is a visual way to indicate the end has been reached.
5030     * This is enabled by default for both axis. This will set if it is enabled
5031     * for that axis with the boolean parameters for each axis.
5032     */
5033    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5034    /**
5035     * @brief Get the bounce mode
5036     *
5037     * @param obj The Scroller object
5038     * @param h_bounce Allow bounce horizontally
5039     * @param v_bounce Allow bounce vertically
5040     *
5041     * @see elm_scroller_bounce_set()
5042     */
5043    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5044    /**
5045     * @brief Set scroll page size relative to viewport size.
5046     *
5047     * @param obj The scroller object
5048     * @param h_pagerel The horizontal page relative size
5049     * @param v_pagerel The vertical page relative size
5050     *
5051     * The scroller is capable of limiting scrolling by the user to "pages". That
5052     * is to jump by and only show a "whole page" at a time as if the continuous
5053     * area of the scroller content is split into page sized pieces. This sets
5054     * the size of a page relative to the viewport of the scroller. 1.0 is "1
5055     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5056     * axis. This is mutually exclusive with page size
5057     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
5058     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5059     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5060     * the other axis.
5061     */
5062    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5063    /**
5064     * @brief Set scroll page size.
5065     *
5066     * @param obj The scroller object
5067     * @param h_pagesize The horizontal page size
5068     * @param v_pagesize The vertical page size
5069     *
5070     * This sets the page size to an absolute fixed value, with 0 turning it off
5071     * for that axis.
5072     *
5073     * @see elm_scroller_page_relative_set()
5074     */
5075    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5076    /**
5077     * @brief Show a specific virtual region within the scroller content object.
5078     *
5079     * @param obj The scroller object
5080     * @param x X coordinate of the region
5081     * @param y Y coordinate of the region
5082     * @param w Width of the region
5083     * @param h Height of the region
5084     *
5085     * This will ensure all (or part if it does not fit) of the designated
5086     * region in the virtual content object (0, 0 starting at the top-left of the
5087     * virtual content object) is shown within the scroller. Unlike
5088     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5089     * to this location (if configuration in general calls for transitions). It
5090     * may not jump immediately to the new location and make take a while and
5091     * show other content along the way.
5092     *
5093     * @see elm_scroller_region_show()
5094     */
5095    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);
5096    /**
5097     * @brief Set event propagation on a scroller
5098     *
5099     * @param obj The scroller object
5100     * @param propagation If propagation is enabled or not
5101     *
5102     * This enables or disabled event propagation from the scroller content to
5103     * the scroller and its parent. By default event propagation is disabled.
5104     */
5105    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5106    /**
5107     * @brief Get event propagation for a scroller
5108     *
5109     * @param obj The scroller object
5110     * @return The propagation state
5111     *
5112     * This gets the event propagation for a scroller.
5113     *
5114     * @see elm_scroller_propagate_events_set()
5115     */
5116    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
5117    /**
5118     * @}
5119     */
5120
5121    /**
5122     * @defgroup Label Label
5123     *
5124     * @image html img/widget/label/preview-00.png
5125     * @image latex img/widget/label/preview-00.eps
5126     *
5127     * @brief Widget to display text, with simple html-like markup.
5128     *
5129     * The Label widget @b doesn't allow text to overflow its boundaries, if the
5130     * text doesn't fit the geometry of the label it will be ellipsized or be
5131     * cut. Elementary provides several themes for this widget:
5132     * @li default - No animation
5133     * @li marker - Centers the text in the label and make it bold by default
5134     * @li slide_long - The entire text appears from the right of the screen and
5135     * slides until it disappears in the left of the screen(reappering on the
5136     * right again).
5137     * @li slide_short - The text appears in the left of the label and slides to
5138     * the right to show the overflow. When all of the text has been shown the
5139     * position is reset.
5140     * @li slide_bounce - The text appears in the left of the label and slides to
5141     * the right to show the overflow. When all of the text has been shown the
5142     * animation reverses, moving the text to the left.
5143     *
5144     * Custom themes can of course invent new markup tags and style them any way
5145     * they like.
5146     *
5147     * See @ref tutorial_label for a demonstration of how to use a label widget.
5148     * @{
5149     */
5150    /**
5151     * @brief Add a new label to the parent
5152     *
5153     * @param parent The parent object
5154     * @return The new object or NULL if it cannot be created
5155     */
5156    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5157    /**
5158     * @brief Set the label on the label object
5159     *
5160     * @param obj The label object
5161     * @param label The label will be used on the label object
5162     * @deprecated See elm_object_text_set()
5163     */
5164    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 */
5165    /**
5166     * @brief Get the label used on the label object
5167     *
5168     * @param obj The label object
5169     * @return The string inside the label
5170     * @deprecated See elm_object_text_get()
5171     */
5172    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5173    /**
5174     * @brief Set the wrapping behavior of the label
5175     *
5176     * @param obj The label object
5177     * @param wrap To wrap text or not
5178     *
5179     * By default no wrapping is done. Possible values for @p wrap are:
5180     * @li ELM_WRAP_NONE - No wrapping
5181     * @li ELM_WRAP_CHAR - wrap between characters
5182     * @li ELM_WRAP_WORD - wrap between words
5183     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5184     */
5185    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5186    /**
5187     * @brief Get the wrapping behavior of the label
5188     *
5189     * @param obj The label object
5190     * @return Wrap type
5191     *
5192     * @see elm_label_line_wrap_set()
5193     */
5194    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5195    /**
5196     * @brief Set wrap width of the label
5197     *
5198     * @param obj The label object
5199     * @param w The wrap width in pixels at a minimum where words need to wrap
5200     *
5201     * This function sets the maximum width size hint of the label.
5202     *
5203     * @warning This is only relevant if the label is inside a container.
5204     */
5205    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5206    /**
5207     * @brief Get wrap width of the label
5208     *
5209     * @param obj The label object
5210     * @return The wrap width in pixels at a minimum where words need to wrap
5211     *
5212     * @see elm_label_wrap_width_set()
5213     */
5214    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5215    /**
5216     * @brief Set wrap height of the label
5217     *
5218     * @param obj The label object
5219     * @param h The wrap height in pixels at a minimum where words need to wrap
5220     *
5221     * This function sets the maximum height size hint of the label.
5222     *
5223     * @warning This is only relevant if the label is inside a container.
5224     */
5225    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5226    /**
5227     * @brief get wrap width of the label
5228     *
5229     * @param obj The label object
5230     * @return The wrap height in pixels at a minimum where words need to wrap
5231     */
5232    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5233    /**
5234     * @brief Set the font size on the label object.
5235     *
5236     * @param obj The label object
5237     * @param size font size
5238     *
5239     * @warning NEVER use this. It is for hyper-special cases only. use styles
5240     * instead. e.g. "big", "medium", "small" - or better name them by use:
5241     * "title", "footnote", "quote" etc.
5242     */
5243    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5244    /**
5245     * @brief Set the text color on the label object
5246     *
5247     * @param obj The label object
5248     * @param r Red property background color of The label object
5249     * @param g Green property background color of The label object
5250     * @param b Blue property background color of The label object
5251     * @param a Alpha property background color of The label object
5252     *
5253     * @warning NEVER use this. It is for hyper-special cases only. use styles
5254     * instead. e.g. "big", "medium", "small" - or better name them by use:
5255     * "title", "footnote", "quote" etc.
5256     */
5257    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);
5258    /**
5259     * @brief Set the text align on the label object
5260     *
5261     * @param obj The label object
5262     * @param align align mode ("left", "center", "right")
5263     *
5264     * @warning NEVER use this. It is for hyper-special cases only. use styles
5265     * instead. e.g. "big", "medium", "small" - or better name them by use:
5266     * "title", "footnote", "quote" etc.
5267     */
5268    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5269    /**
5270     * @brief Set background color of the label
5271     *
5272     * @param obj The label object
5273     * @param r Red property background color of The label object
5274     * @param g Green property background color of The label object
5275     * @param b Blue property background color of The label object
5276     * @param a Alpha property background alpha of The label object
5277     *
5278     * @warning NEVER use this. It is for hyper-special cases only. use styles
5279     * instead. e.g. "big", "medium", "small" - or better name them by use:
5280     * "title", "footnote", "quote" etc.
5281     */
5282    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);
5283    /**
5284     * @brief Set the ellipsis behavior of the label
5285     *
5286     * @param obj The label object
5287     * @param ellipsis To ellipsis text or not
5288     *
5289     * If set to true and the text doesn't fit in the label an ellipsis("...")
5290     * will be shown at the end of the widget.
5291     *
5292     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5293     * choosen wrap method was ELM_WRAP_WORD.
5294     */
5295    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5296    /**
5297     * @brief Set the text slide of the label
5298     *
5299     * @param obj The label object
5300     * @param slide To start slide or stop
5301     *
5302     * If set to true the text of the label will slide throught the length of
5303     * label.
5304     *
5305     * @warning This only work with the themes "slide_short", "slide_long" and
5306     * "slide_bounce".
5307     */
5308    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5309    /**
5310     * @brief Get the text slide mode of the label
5311     *
5312     * @param obj The label object
5313     * @return slide slide mode value
5314     *
5315     * @see elm_label_slide_set()
5316     */
5317    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5318    /**
5319     * @brief Set the slide duration(speed) of the label
5320     *
5321     * @param obj The label object
5322     * @return The duration in seconds in moving text from slide begin position
5323     * to slide end position
5324     */
5325    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5326    /**
5327     * @brief Get the slide duration(speed) of the label
5328     *
5329     * @param obj The label object
5330     * @return The duration time in moving text from slide begin position to slide end position
5331     *
5332     * @see elm_label_slide_duration_set()
5333     */
5334    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5335    /**
5336     * @}
5337     */
5338
5339    /**
5340     * @defgroup Toggle Toggle
5341     *
5342     * @image html img/widget/toggle/preview-00.png
5343     * @image latex img/widget/toggle/preview-00.eps
5344     *
5345     * @brief A toggle is a slider which can be used to toggle between
5346     * two values.  It has two states: on and off.
5347     *
5348     * Signals that you can add callbacks for are:
5349     * @li "changed" - Whenever the toggle value has been changed.  Is not called
5350     *                 until the toggle is released by the cursor (assuming it
5351     *                 has been triggered by the cursor in the first place).
5352     *
5353     * @ref tutorial_toggle show how to use a toggle.
5354     * @{
5355     */
5356    /**
5357     * @brief Add a toggle to @p parent.
5358     *
5359     * @param parent The parent object
5360     *
5361     * @return The toggle object
5362     */
5363    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5364    /**
5365     * @brief Sets the label to be displayed with the toggle.
5366     *
5367     * @param obj The toggle object
5368     * @param label The label to be displayed
5369     *
5370     * @deprecated use elm_object_text_set() instead.
5371     */
5372    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5373    /**
5374     * @brief Gets the label of the toggle
5375     *
5376     * @param obj  toggle object
5377     * @return The label of the toggle
5378     *
5379     * @deprecated use elm_object_text_get() instead.
5380     */
5381    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5382    /**
5383     * @brief Set the icon used for the toggle
5384     *
5385     * @param obj The toggle object
5386     * @param icon The icon object for the button
5387     *
5388     * Once the icon object is set, a previously set one will be deleted
5389     * If you want to keep that old content object, use the
5390     * elm_toggle_icon_unset() function.
5391     */
5392    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5393    /**
5394     * @brief Get the icon used for the toggle
5395     *
5396     * @param obj The toggle object
5397     * @return The icon object that is being used
5398     *
5399     * Return the icon object which is set for this widget.
5400     *
5401     * @see elm_toggle_icon_set()
5402     */
5403    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5404    /**
5405     * @brief Unset the icon used for the toggle
5406     *
5407     * @param obj The toggle object
5408     * @return The icon object that was being used
5409     *
5410     * Unparent and return the icon object which was set for this widget.
5411     *
5412     * @see elm_toggle_icon_set()
5413     */
5414    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5415    /**
5416     * @brief Sets the labels to be associated with the on and off states of the toggle.
5417     *
5418     * @param obj The toggle object
5419     * @param onlabel The label displayed when the toggle is in the "on" state
5420     * @param offlabel The label displayed when the toggle is in the "off" state
5421     */
5422    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5423    /**
5424     * @brief Gets the labels associated with the on and off states of the toggle.
5425     *
5426     * @param obj The toggle object
5427     * @param onlabel A char** to place the onlabel of @p obj into
5428     * @param offlabel A char** to place the offlabel of @p obj into
5429     */
5430    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5431    /**
5432     * @brief Sets the state of the toggle to @p state.
5433     *
5434     * @param obj The toggle object
5435     * @param state The state of @p obj
5436     */
5437    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5438    /**
5439     * @brief Gets the state of the toggle to @p state.
5440     *
5441     * @param obj The toggle object
5442     * @return The state of @p obj
5443     */
5444    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5445    /**
5446     * @brief Sets the state pointer of the toggle to @p statep.
5447     *
5448     * @param obj The toggle object
5449     * @param statep The state pointer of @p obj
5450     */
5451    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5452    /**
5453     * @}
5454     */
5455
5456    /**
5457     * @defgroup Frame Frame
5458     *
5459     * @image html img/widget/frame/preview-00.png
5460     * @image latex img/widget/frame/preview-00.eps
5461     *
5462     * @brief Frame is a widget that holds some content and has a title.
5463     *
5464     * The default look is a frame with a title, but Frame supports multple
5465     * styles:
5466     * @li default
5467     * @li pad_small
5468     * @li pad_medium
5469     * @li pad_large
5470     * @li pad_huge
5471     * @li outdent_top
5472     * @li outdent_bottom
5473     *
5474     * Of all this styles only default shows the title. Frame emits no signals.
5475     *
5476     * For a detailed example see the @ref tutorial_frame.
5477     *
5478     * @{
5479     */
5480    /**
5481     * @brief Add a new frame to the parent
5482     *
5483     * @param parent The parent object
5484     * @return The new object or NULL if it cannot be created
5485     */
5486    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5487    /**
5488     * @brief Set the frame label
5489     *
5490     * @param obj The frame object
5491     * @param label The label of this frame object
5492     *
5493     * @deprecated use elm_object_text_set() instead.
5494     */
5495    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5496    /**
5497     * @brief Get the frame label
5498     *
5499     * @param obj The frame object
5500     *
5501     * @return The label of this frame objet or NULL if unable to get frame
5502     *
5503     * @deprecated use elm_object_text_get() instead.
5504     */
5505    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5506    /**
5507     * @brief Set the content of the frame widget
5508     *
5509     * Once the content object is set, a previously set one will be deleted.
5510     * If you want to keep that old content object, use the
5511     * elm_frame_content_unset() function.
5512     *
5513     * @param obj The frame object
5514     * @param content The content will be filled in this frame object
5515     */
5516    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5517    /**
5518     * @brief Get the content of the frame widget
5519     *
5520     * Return the content object which is set for this widget
5521     *
5522     * @param obj The frame object
5523     * @return The content that is being used
5524     */
5525    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5526    /**
5527     * @brief Unset the content of the frame widget
5528     *
5529     * Unparent and return the content object which was set for this widget
5530     *
5531     * @param obj The frame object
5532     * @return The content that was being used
5533     */
5534    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5535    /**
5536     * @}
5537     */
5538
5539    /**
5540     * @defgroup Table Table
5541     *
5542     * A container widget to arrange other widgets in a table where items can
5543     * also span multiple columns or rows - even overlap (and then be raised or
5544     * lowered accordingly to adjust stacking if they do overlap).
5545     *
5546     * The followin are examples of how to use a table:
5547     * @li @ref tutorial_table_01
5548     * @li @ref tutorial_table_02
5549     *
5550     * @{
5551     */
5552    /**
5553     * @brief Add a new table to the parent
5554     *
5555     * @param parent The parent object
5556     * @return The new object or NULL if it cannot be created
5557     */
5558    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5559    /**
5560     * @brief Set the homogeneous layout in the table
5561     *
5562     * @param obj The layout object
5563     * @param homogeneous A boolean to set if the layout is homogeneous in the
5564     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
5565     */
5566    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5567    /**
5568     * @brief Get the current table homogeneous mode.
5569     *
5570     * @param obj The table object
5571     * @return A boolean to indicating if the layout is homogeneous in the table
5572     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
5573     */
5574    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5575    /**
5576     * @warning <b>Use elm_table_homogeneous_set() instead</b>
5577     */
5578    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5579    /**
5580     * @warning <b>Use elm_table_homogeneous_get() instead</b>
5581     */
5582    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5583    /**
5584     * @brief Set padding between cells.
5585     *
5586     * @param obj The layout object.
5587     * @param horizontal set the horizontal padding.
5588     * @param vertical set the vertical padding.
5589     *
5590     * Default value is 0.
5591     */
5592    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5593    /**
5594     * @brief Get padding between cells.
5595     *
5596     * @param obj The layout object.
5597     * @param horizontal set the horizontal padding.
5598     * @param vertical set the vertical padding.
5599     */
5600    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5601    /**
5602     * @brief Add a subobject on the table with the coordinates passed
5603     *
5604     * @param obj The table object
5605     * @param subobj The subobject to be added to the table
5606     * @param x Row number
5607     * @param y Column number
5608     * @param w rowspan
5609     * @param h colspan
5610     *
5611     * @note All positioning inside the table is relative to rows and columns, so
5612     * a value of 0 for x and y, means the top left cell of the table, and a
5613     * value of 1 for w and h means @p subobj only takes that 1 cell.
5614     */
5615    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5616    /**
5617     * @brief Remove child from table.
5618     *
5619     * @param obj The table object
5620     * @param subobj The subobject
5621     */
5622    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5623    /**
5624     * @brief Faster way to remove all child objects from a table object.
5625     *
5626     * @param obj The table object
5627     * @param clear If true, will delete children, else just remove from table.
5628     */
5629    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5630    /**
5631     * @brief Set the packing location of an existing child of the table
5632     *
5633     * @param subobj The subobject to be modified in the table
5634     * @param x Row number
5635     * @param y Column number
5636     * @param w rowspan
5637     * @param h colspan
5638     *
5639     * Modifies the position of an object already in the table.
5640     *
5641     * @note All positioning inside the table is relative to rows and columns, so
5642     * a value of 0 for x and y, means the top left cell of the table, and a
5643     * value of 1 for w and h means @p subobj only takes that 1 cell.
5644     */
5645    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5646    /**
5647     * @brief Get the packing location of an existing child of the table
5648     *
5649     * @param subobj The subobject to be modified in the table
5650     * @param x Row number
5651     * @param y Column number
5652     * @param w rowspan
5653     * @param h colspan
5654     *
5655     * @see elm_table_pack_set()
5656     */
5657    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5658    /**
5659     * @}
5660     */
5661
5662    /**
5663     * @defgroup Gengrid Gengrid (Generic grid)
5664     *
5665     * This widget aims to position objects in a grid layout while
5666     * actually creating and rendering only the visible ones, using the
5667     * same idea as the @ref Genlist "genlist": the user defines a @b
5668     * class for each item, specifying functions that will be called at
5669     * object creation, deletion, etc. When those items are selected by
5670     * the user, a callback function is issued. Users may interact with
5671     * a gengrid via the mouse (by clicking on items to select them and
5672     * clicking on the grid's viewport and swiping to pan the whole
5673     * view) or via the keyboard, navigating through item with the
5674     * arrow keys.
5675     *
5676     * @section Gengrid_Layouts Gengrid layouts
5677     *
5678     * Gengrids may layout its items in one of two possible layouts:
5679     * - horizontal or
5680     * - vertical.
5681     *
5682     * When in "horizontal mode", items will be placed in @b columns,
5683     * from top to bottom and, when the space for a column is filled,
5684     * another one is started on the right, thus expanding the grid
5685     * horizontally, making for horizontal scrolling. When in "vertical
5686     * mode" , though, items will be placed in @b rows, from left to
5687     * right and, when the space for a row is filled, another one is
5688     * started below, thus expanding the grid vertically (and making
5689     * for vertical scrolling).
5690     *
5691     * @section Gengrid_Items Gengrid items
5692     *
5693     * An item in a gengrid can have 0 or more text labels (they can be
5694     * regular text or textblock Evas objects - that's up to the style
5695     * to determine), 0 or more icons (which are simply objects
5696     * swallowed into the gengrid item's theming Edje object) and 0 or
5697     * more <b>boolean states</b>, which have the behavior left to the
5698     * user to define. The Edje part names for each of these properties
5699     * will be looked up, in the theme file for the gengrid, under the
5700     * Edje (string) data items named @c "labels", @c "icons" and @c
5701     * "states", respectively. For each of those properties, if more
5702     * than one part is provided, they must have names listed separated
5703     * by spaces in the data fields. For the default gengrid item
5704     * theme, we have @b one label part (@c "elm.text"), @b two icon
5705     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5706     * no state parts.
5707     *
5708     * A gengrid item may be at one of several styles. Elementary
5709     * provides one by default - "default", but this can be extended by
5710     * system or application custom themes/overlays/extensions (see
5711     * @ref Theme "themes" for more details).
5712     *
5713     * @section Gengrid_Item_Class Gengrid item classes
5714     *
5715     * In order to have the ability to add and delete items on the fly,
5716     * gengrid implements a class (callback) system where the
5717     * application provides a structure with information about that
5718     * type of item (gengrid may contain multiple different items with
5719     * different classes, states and styles). Gengrid will call the
5720     * functions in this struct (methods) when an item is "realized"
5721     * (i.e., created dynamically, while the user is scrolling the
5722     * grid). All objects will simply be deleted when no longer needed
5723     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5724     * contains the following members:
5725     * - @c item_style - This is a constant string and simply defines
5726     * the name of the item style. It @b must be specified and the
5727     * default should be @c "default".
5728     * - @c func.label_get - This function is called when an item
5729     * object is actually created. The @c data parameter will point to
5730     * the same data passed to elm_gengrid_item_append() and related
5731     * item creation functions. The @c obj parameter is the gengrid
5732     * object itself, while the @c part one is the name string of one
5733     * of the existing text parts in the Edje group implementing the
5734     * item's theme. This function @b must return a strdup'()ed string,
5735     * as the caller will free() it when done. See
5736     * #GridItemLabelGetFunc.
5737     * - @c func.icon_get - This function is called when an item object
5738     * is actually created. The @c data parameter will point to the
5739     * same data passed to elm_gengrid_item_append() and related item
5740     * creation functions. The @c obj parameter is the gengrid object
5741     * itself, while the @c part one is the name string of one of the
5742     * existing (icon) swallow parts in the Edje group implementing the
5743     * item's theme. It must return @c NULL, when no icon is desired,
5744     * or a valid object handle, otherwise. The object will be deleted
5745     * by the gengrid on its deletion or when the item is "unrealized".
5746     * See #GridItemIconGetFunc.
5747     * - @c func.state_get - This function is called when an item
5748     * object is actually created. The @c data parameter will point to
5749     * the same data passed to elm_gengrid_item_append() and related
5750     * item creation functions. The @c obj parameter is the gengrid
5751     * object itself, while the @c part one is the name string of one
5752     * of the state parts in the Edje group implementing the item's
5753     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5754     * true/on. Gengrids will emit a signal to its theming Edje object
5755     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5756     * "source" arguments, respectively, when the state is true (the
5757     * default is false), where @c XXX is the name of the (state) part.
5758     * See #GridItemStateGetFunc.
5759     * - @c func.del - This is called when elm_gengrid_item_del() is
5760     * called on an item or elm_gengrid_clear() is called on the
5761     * gengrid. This is intended for use when gengrid items are
5762     * deleted, so any data attached to the item (e.g. its data
5763     * parameter on creation) can be deleted. See #GridItemDelFunc.
5764     *
5765     * @section Gengrid_Usage_Hints Usage hints
5766     *
5767     * If the user wants to have multiple items selected at the same
5768     * time, elm_gengrid_multi_select_set() will permit it. If the
5769     * gengrid is single-selection only (the default), then
5770     * elm_gengrid_select_item_get() will return the selected item or
5771     * @c NULL, if none is selected. If the gengrid is under
5772     * multi-selection, then elm_gengrid_selected_items_get() will
5773     * return a list (that is only valid as long as no items are
5774     * modified (added, deleted, selected or unselected) of child items
5775     * on a gengrid.
5776     *
5777     * If an item changes (internal (boolean) state, label or icon
5778     * changes), then use elm_gengrid_item_update() to have gengrid
5779     * update the item with the new state. A gengrid will re-"realize"
5780     * the item, thus calling the functions in the
5781     * #Elm_Gengrid_Item_Class set for that item.
5782     *
5783     * To programmatically (un)select an item, use
5784     * elm_gengrid_item_selected_set(). To get its selected state use
5785     * elm_gengrid_item_selected_get(). To make an item disabled
5786     * (unable to be selected and appear differently) use
5787     * elm_gengrid_item_disabled_set() to set this and
5788     * elm_gengrid_item_disabled_get() to get the disabled state.
5789     *
5790     * Grid cells will only have their selection smart callbacks called
5791     * when firstly getting selected. Any further clicks will do
5792     * nothing, unless you enable the "always select mode", with
5793     * elm_gengrid_always_select_mode_set(), thus making every click to
5794     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5795     * turn off the ability to select items entirely in the widget and
5796     * they will neither appear selected nor call the selection smart
5797     * callbacks.
5798     *
5799     * Remember that you can create new styles and add your own theme
5800     * augmentation per application with elm_theme_extension_add(). If
5801     * you absolutely must have a specific style that overrides any
5802     * theme the user or system sets up you can use
5803     * elm_theme_overlay_add() to add such a file.
5804     *
5805     * @section Gengrid_Smart_Events Gengrid smart events
5806     *
5807     * Smart events that you can add callbacks for are:
5808     * - @c "activated" - The user has double-clicked or pressed
5809     *   (enter|return|spacebar) on an item. The @c event_info parameter
5810     *   is the gengrid item that was activated.
5811     * - @c "clicked,double" - The user has double-clicked an item.
5812     *   The @c event_info parameter is the gengrid item that was double-clicked.
5813     * - @c "selected" - The user has made an item selected. The
5814     *   @c event_info parameter is the gengrid item that was selected.
5815     * - @c "unselected" - The user has made an item unselected. The
5816     *   @c event_info parameter is the gengrid item that was unselected.
5817     * - @c "realized" - This is called when the item in the gengrid
5818     *   has its implementing Evas object instantiated, de facto. @c
5819     *   event_info is the gengrid item that was created. The object
5820     *   may be deleted at any time, so it is highly advised to the
5821     *   caller @b not to use the object pointer returned from
5822     *   elm_gengrid_item_object_get(), because it may point to freed
5823     *   objects.
5824     * - @c "unrealized" - This is called when the implementing Evas
5825     *   object for this item is deleted. @c event_info is the gengrid
5826     *   item that was deleted.
5827     * - @c "changed" - Called when an item is added, removed, resized
5828     *   or moved and when the gengrid is resized or gets "horizontal"
5829     *   property changes.
5830     * - @c "drag,start,up" - Called when the item in the gengrid has
5831     *   been dragged (not scrolled) up.
5832     * - @c "drag,start,down" - Called when the item in the gengrid has
5833     *   been dragged (not scrolled) down.
5834     * - @c "drag,start,left" - Called when the item in the gengrid has
5835     *   been dragged (not scrolled) left.
5836     * - @c "drag,start,right" - Called when the item in the gengrid has
5837     *   been dragged (not scrolled) right.
5838     * - @c "drag,stop" - Called when the item in the gengrid has
5839     *   stopped being dragged.
5840     * - @c "drag" - Called when the item in the gengrid is being
5841     *   dragged.
5842     * - @c "scroll" - called when the content has been scrolled
5843     *   (moved).
5844     * - @c "scroll,drag,start" - called when dragging the content has
5845     *   started.
5846     * - @c "scroll,drag,stop" - called when dragging the content has
5847     *   stopped.
5848     *
5849     * List of gendrid examples:
5850     * @li @ref gengrid_example
5851     */
5852
5853    /**
5854     * @addtogroup Gengrid
5855     * @{
5856     */
5857
5858    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5859    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5860    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5861    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5862    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5863    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5864    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5865
5866    /**
5867     * @struct _Elm_Gengrid_Item_Class
5868     *
5869     * Gengrid item class definition. See @ref Gengrid_Item_Class for
5870     * field details.
5871     */
5872    struct _Elm_Gengrid_Item_Class
5873      {
5874         const char             *item_style;
5875         struct _Elm_Gengrid_Item_Class_Func
5876           {
5877              GridItemLabelGetFunc  label_get;
5878              GridItemIconGetFunc   icon_get;
5879              GridItemStateGetFunc  state_get;
5880              GridItemDelFunc       del;
5881           } func;
5882      }; /**< #Elm_Gengrid_Item_Class member definitions */
5883
5884    /**
5885     * Add a new gengrid widget to the given parent Elementary
5886     * (container) object
5887     *
5888     * @param parent The parent object
5889     * @return a new gengrid widget handle or @c NULL, on errors
5890     *
5891     * This function inserts a new gengrid widget on the canvas.
5892     *
5893     * @see elm_gengrid_item_size_set()
5894     * @see elm_gengrid_horizontal_set()
5895     * @see elm_gengrid_item_append()
5896     * @see elm_gengrid_item_del()
5897     * @see elm_gengrid_clear()
5898     *
5899     * @ingroup Gengrid
5900     */
5901    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5902
5903    /**
5904     * Set the size for the items of a given gengrid widget
5905     *
5906     * @param obj The gengrid object.
5907     * @param w The items' width.
5908     * @param h The items' height;
5909     *
5910     * A gengrid, after creation, has still no information on the size
5911     * to give to each of its cells. So, you most probably will end up
5912     * with squares one @ref Fingers "finger" wide, the default
5913     * size. Use this function to force a custom size for you items,
5914     * making them as big as you wish.
5915     *
5916     * @see elm_gengrid_item_size_get()
5917     *
5918     * @ingroup Gengrid
5919     */
5920    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5921
5922    /**
5923     * Get the size set for the items of a given gengrid widget
5924     *
5925     * @param obj The gengrid object.
5926     * @param w Pointer to a variable where to store the items' width.
5927     * @param h Pointer to a variable where to store the items' height.
5928     *
5929     * @note Use @c NULL pointers on the size values you're not
5930     * interested in: they'll be ignored by the function.
5931     *
5932     * @see elm_gengrid_item_size_get() for more details
5933     *
5934     * @ingroup Gengrid
5935     */
5936    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5937
5938    /**
5939     * Set the items grid's alignment within a given gengrid widget
5940     *
5941     * @param obj The gengrid object.
5942     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
5943     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
5944     *
5945     * This sets the alignment of the whole grid of items of a gengrid
5946     * within its given viewport. By default, those values are both
5947     * 0.5, meaning that the gengrid will have its items grid placed
5948     * exactly in the middle of its viewport.
5949     *
5950     * @note If given alignment values are out of the cited ranges,
5951     * they'll be changed to the nearest boundary values on the valid
5952     * ranges.
5953     *
5954     * @see elm_gengrid_align_get()
5955     *
5956     * @ingroup Gengrid
5957     */
5958    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5959
5960    /**
5961     * Get the items grid's alignment values within a given gengrid
5962     * widget
5963     *
5964     * @param obj The gengrid object.
5965     * @param align_x Pointer to a variable where to store the
5966     * horizontal alignment.
5967     * @param align_y Pointer to a variable where to store the vertical
5968     * alignment.
5969     *
5970     * @note Use @c NULL pointers on the alignment values you're not
5971     * interested in: they'll be ignored by the function.
5972     *
5973     * @see elm_gengrid_align_set() for more details
5974     *
5975     * @ingroup Gengrid
5976     */
5977    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5978
5979    /**
5980     * Set whether a given gengrid widget is or not able have items
5981     * @b reordered
5982     *
5983     * @param obj The gengrid object
5984     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
5985     * @c EINA_FALSE to turn it off
5986     *
5987     * If a gengrid is set to allow reordering, a click held for more
5988     * than 0.5 over a given item will highlight it specially,
5989     * signalling the gengrid has entered the reordering state. From
5990     * that time on, the user will be able to, while still holding the
5991     * mouse button down, move the item freely in the gengrid's
5992     * viewport, replacing to said item to the locations it goes to.
5993     * The replacements will be animated and, whenever the user
5994     * releases the mouse button, the item being replaced gets a new
5995     * definitive place in the grid.
5996     *
5997     * @see elm_gengrid_reorder_mode_get()
5998     *
5999     * @ingroup Gengrid
6000     */
6001    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6002
6003    /**
6004     * Get whether a given gengrid widget is or not able have items
6005     * @b reordered
6006     *
6007     * @param obj The gengrid object
6008     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6009     * off
6010     *
6011     * @see elm_gengrid_reorder_mode_set() for more details
6012     *
6013     * @ingroup Gengrid
6014     */
6015    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6016
6017    /**
6018     * Append a new item in a given gengrid widget.
6019     *
6020     * @param obj The gengrid object.
6021     * @param gic The item class for the item.
6022     * @param data The item data.
6023     * @param func Convenience function called when the item is
6024     * selected.
6025     * @param func_data Data to be passed to @p func.
6026     * @return A handle to the item added or @c NULL, on errors.
6027     *
6028     * This adds an item to the beginning of the gengrid.
6029     *
6030     * @see elm_gengrid_item_prepend()
6031     * @see elm_gengrid_item_insert_before()
6032     * @see elm_gengrid_item_insert_after()
6033     * @see elm_gengrid_item_del()
6034     *
6035     * @ingroup Gengrid
6036     */
6037    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);
6038
6039    /**
6040     * Prepend a new item in a given gengrid widget.
6041     *
6042     * @param obj The gengrid object.
6043     * @param gic The item class for the item.
6044     * @param data The item data.
6045     * @param func Convenience function called when the item is
6046     * selected.
6047     * @param func_data Data to be passed to @p func.
6048     * @return A handle to the item added or @c NULL, on errors.
6049     *
6050     * This adds an item to the end of the gengrid.
6051     *
6052     * @see elm_gengrid_item_append()
6053     * @see elm_gengrid_item_insert_before()
6054     * @see elm_gengrid_item_insert_after()
6055     * @see elm_gengrid_item_del()
6056     *
6057     * @ingroup Gengrid
6058     */
6059    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);
6060
6061    /**
6062     * Insert an item before another in a gengrid widget
6063     *
6064     * @param obj The gengrid object.
6065     * @param gic The item class for the item.
6066     * @param data The item data.
6067     * @param relative The item to place this new one before.
6068     * @param func Convenience function called when the item is
6069     * selected.
6070     * @param func_data Data to be passed to @p func.
6071     * @return A handle to the item added or @c NULL, on errors.
6072     *
6073     * This inserts an item before another in the gengrid.
6074     *
6075     * @see elm_gengrid_item_append()
6076     * @see elm_gengrid_item_prepend()
6077     * @see elm_gengrid_item_insert_after()
6078     * @see elm_gengrid_item_del()
6079     *
6080     * @ingroup Gengrid
6081     */
6082    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);
6083
6084    /**
6085     * Insert an item after another in a gengrid widget
6086     *
6087     * @param obj The gengrid object.
6088     * @param gic The item class for the item.
6089     * @param data The item data.
6090     * @param relative The item to place this new one after.
6091     * @param func Convenience function called when the item is
6092     * selected.
6093     * @param func_data Data to be passed to @p func.
6094     * @return A handle to the item added or @c NULL, on errors.
6095     *
6096     * This inserts an item after another in the gengrid.
6097     *
6098     * @see elm_gengrid_item_append()
6099     * @see elm_gengrid_item_prepend()
6100     * @see elm_gengrid_item_insert_after()
6101     * @see elm_gengrid_item_del()
6102     *
6103     * @ingroup Gengrid
6104     */
6105    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);
6106
6107    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);
6108
6109    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);
6110
6111    /**
6112     * Set whether items on a given gengrid widget are to get their
6113     * selection callbacks issued for @b every subsequent selection
6114     * click on them or just for the first click.
6115     *
6116     * @param obj The gengrid object
6117     * @param always_select @c EINA_TRUE to make items "always
6118     * selected", @c EINA_FALSE, otherwise
6119     *
6120     * By default, grid items will only call their selection callback
6121     * function when firstly getting selected, any subsequent further
6122     * clicks will do nothing. With this call, you make those
6123     * subsequent clicks also to issue the selection callbacks.
6124     *
6125     * @note <b>Double clicks</b> will @b always be reported on items.
6126     *
6127     * @see elm_gengrid_always_select_mode_get()
6128     *
6129     * @ingroup Gengrid
6130     */
6131    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6132
6133    /**
6134     * Get whether items on a given gengrid widget have their selection
6135     * callbacks issued for @b every subsequent selection click on them
6136     * or just for the first click.
6137     *
6138     * @param obj The gengrid object.
6139     * @return @c EINA_TRUE if the gengrid items are "always selected",
6140     * @c EINA_FALSE, otherwise
6141     *
6142     * @see elm_gengrid_always_select_mode_set() for more details
6143     *
6144     * @ingroup Gengrid
6145     */
6146    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6147
6148    /**
6149     * Set whether items on a given gengrid widget can be selected or not.
6150     *
6151     * @param obj The gengrid object
6152     * @param no_select @c EINA_TRUE to make items selectable,
6153     * @c EINA_FALSE otherwise
6154     *
6155     * This will make items in @p obj selectable or not. In the latter
6156     * case, any user interacion on the gendrid items will neither make
6157     * them appear selected nor them call their selection callback
6158     * functions.
6159     *
6160     * @see elm_gengrid_no_select_mode_get()
6161     *
6162     * @ingroup Gengrid
6163     */
6164    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6165
6166    /**
6167     * Get whether items on a given gengrid widget can be selected or
6168     * not.
6169     *
6170     * @param obj The gengrid object
6171     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6172     * otherwise
6173     *
6174     * @see elm_gengrid_no_select_mode_set() for more details
6175     *
6176     * @ingroup Gengrid
6177     */
6178    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6179
6180    /**
6181     * Enable or disable multi-selection in a given gengrid widget
6182     *
6183     * @param obj The gengrid object.
6184     * @param multi @c EINA_TRUE, to enable multi-selection,
6185     * @c EINA_FALSE to disable it.
6186     *
6187     * Multi-selection is the ability for one to have @b more than one
6188     * item selected, on a given gengrid, simultaneously. When it is
6189     * enabled, a sequence of clicks on different items will make them
6190     * all selected, progressively. A click on an already selected item
6191     * will unselect it. If interecting via the keyboard,
6192     * multi-selection is enabled while holding the "Shift" key.
6193     *
6194     * @note By default, multi-selection is @b disabled on gengrids
6195     *
6196     * @see elm_gengrid_multi_select_get()
6197     *
6198     * @ingroup Gengrid
6199     */
6200    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6201
6202    /**
6203     * Get whether multi-selection is enabled or disabled for a given
6204     * gengrid widget
6205     *
6206     * @param obj The gengrid object.
6207     * @return @c EINA_TRUE, if multi-selection is enabled, @c
6208     * EINA_FALSE otherwise
6209     *
6210     * @see elm_gengrid_multi_select_set() for more details
6211     *
6212     * @ingroup Gengrid
6213     */
6214    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6215
6216    /**
6217     * Enable or disable bouncing effect for a given gengrid widget
6218     *
6219     * @param obj The gengrid object
6220     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6221     * @c EINA_FALSE to disable it
6222     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6223     * @c EINA_FALSE to disable it
6224     *
6225     * The bouncing effect occurs whenever one reaches the gengrid's
6226     * edge's while panning it -- it will scroll past its limits a
6227     * little bit and return to the edge again, in a animated for,
6228     * automatically.
6229     *
6230     * @note By default, gengrids have bouncing enabled on both axis
6231     *
6232     * @see elm_gengrid_bounce_get()
6233     *
6234     * @ingroup Gengrid
6235     */
6236    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6237
6238    /**
6239     * Get whether bouncing effects are enabled or disabled, for a
6240     * given gengrid widget, on each axis
6241     *
6242     * @param obj The gengrid object
6243     * @param h_bounce Pointer to a variable where to store the
6244     * horizontal bouncing flag.
6245     * @param v_bounce Pointer to a variable where to store the
6246     * vertical bouncing flag.
6247     *
6248     * @see elm_gengrid_bounce_set() for more details
6249     *
6250     * @ingroup Gengrid
6251     */
6252    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6253
6254    /**
6255     * Set a given gengrid widget's scrolling page size, relative to
6256     * its viewport size.
6257     *
6258     * @param obj The gengrid object
6259     * @param h_pagerel The horizontal page (relative) size
6260     * @param v_pagerel The vertical page (relative) size
6261     *
6262     * The gengrid's scroller is capable of binding scrolling by the
6263     * user to "pages". It means that, while scrolling and, specially
6264     * after releasing the mouse button, the grid will @b snap to the
6265     * nearest displaying page's area. When page sizes are set, the
6266     * grid's continuous content area is split into (equal) page sized
6267     * pieces.
6268     *
6269     * This function sets the size of a page <b>relatively to the
6270     * viewport dimensions</b> of the gengrid, for each axis. A value
6271     * @c 1.0 means "the exact viewport's size", in that axis, while @c
6272     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6273     * a viewport". Sane usable values are, than, between @c 0.0 and @c
6274     * 1.0. Values beyond those will make it behave behave
6275     * inconsistently. If you only want one axis to snap to pages, use
6276     * the value @c 0.0 for the other one.
6277     *
6278     * There is a function setting page size values in @b absolute
6279     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6280     * is mutually exclusive to this one.
6281     *
6282     * @see elm_gengrid_page_relative_get()
6283     *
6284     * @ingroup Gengrid
6285     */
6286    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6287
6288    /**
6289     * Get a given gengrid widget's scrolling page size, relative to
6290     * its viewport size.
6291     *
6292     * @param obj The gengrid object
6293     * @param h_pagerel Pointer to a variable where to store the
6294     * horizontal page (relative) size
6295     * @param v_pagerel Pointer to a variable where to store the
6296     * vertical page (relative) size
6297     *
6298     * @see elm_gengrid_page_relative_set() for more details
6299     *
6300     * @ingroup Gengrid
6301     */
6302    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6303
6304    /**
6305     * Set a given gengrid widget's scrolling page size
6306     *
6307     * @param obj The gengrid object
6308     * @param h_pagerel The horizontal page size, in pixels
6309     * @param v_pagerel The vertical page size, in pixels
6310     *
6311     * The gengrid's scroller is capable of binding scrolling by the
6312     * user to "pages". It means that, while scrolling and, specially
6313     * after releasing the mouse button, the grid will @b snap to the
6314     * nearest displaying page's area. When page sizes are set, the
6315     * grid's continuous content area is split into (equal) page sized
6316     * pieces.
6317     *
6318     * This function sets the size of a page of the gengrid, in pixels,
6319     * for each axis. Sane usable values are, between @c 0 and the
6320     * dimensions of @p obj, for each axis. Values beyond those will
6321     * make it behave behave inconsistently. If you only want one axis
6322     * to snap to pages, use the value @c 0 for the other one.
6323     *
6324     * There is a function setting page size values in @b relative
6325     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6326     * use is mutually exclusive to this one.
6327     *
6328     * @ingroup Gengrid
6329     */
6330    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6331
6332    /**
6333     * Set for what direction a given gengrid widget will expand while
6334     * placing its items.
6335     *
6336     * @param obj The gengrid object.
6337     * @param setting @c EINA_TRUE to make the gengrid expand
6338     * horizontally, @c EINA_FALSE to expand vertically.
6339     *
6340     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6341     * in @b columns, from top to bottom and, when the space for a
6342     * column is filled, another one is started on the right, thus
6343     * expanding the grid horizontally. When in "vertical mode"
6344     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6345     * to right and, when the space for a row is filled, another one is
6346     * started below, thus expanding the grid vertically.
6347     *
6348     * @see elm_gengrid_horizontal_get()
6349     *
6350     * @ingroup Gengrid
6351     */
6352    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6353
6354    /**
6355     * Get for what direction a given gengrid widget will expand while
6356     * placing its items.
6357     *
6358     * @param obj The gengrid object.
6359     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6360     * @c EINA_FALSE if it's set to expand vertically.
6361     *
6362     * @see elm_gengrid_horizontal_set() for more detais
6363     *
6364     * @ingroup Gengrid
6365     */
6366    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6367
6368    /**
6369     * Get the first item in a given gengrid widget
6370     *
6371     * @param obj The gengrid object
6372     * @return The first item's handle or @c NULL, if there are no
6373     * items in @p obj (and on errors)
6374     *
6375     * This returns the first item in the @p obj's internal list of
6376     * items.
6377     *
6378     * @see elm_gengrid_last_item_get()
6379     *
6380     * @ingroup Gengrid
6381     */
6382    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6383
6384    /**
6385     * Get the last item in a given gengrid widget
6386     *
6387     * @param obj The gengrid object
6388     * @return The last item's handle or @c NULL, if there are no
6389     * items in @p obj (and on errors)
6390     *
6391     * This returns the last item in the @p obj's internal list of
6392     * items.
6393     *
6394     * @see elm_gengrid_first_item_get()
6395     *
6396     * @ingroup Gengrid
6397     */
6398    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6399
6400    /**
6401     * Get the @b next item in a gengrid widget's internal list of items,
6402     * given a handle to one of those items.
6403     *
6404     * @param item The gengrid item to fetch next from
6405     * @return The item after @p item, or @c NULL if there's none (and
6406     * on errors)
6407     *
6408     * This returns the item placed after the @p item, on the container
6409     * gengrid.
6410     *
6411     * @see elm_gengrid_item_prev_get()
6412     *
6413     * @ingroup Gengrid
6414     */
6415    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6416
6417    /**
6418     * Get the @b previous item in a gengrid widget's internal list of items,
6419     * given a handle to one of those items.
6420     *
6421     * @param item The gengrid item to fetch previous from
6422     * @return The item before @p item, or @c NULL if there's none (and
6423     * on errors)
6424     *
6425     * This returns the item placed before the @p item, on the container
6426     * gengrid.
6427     *
6428     * @see elm_gengrid_item_next_get()
6429     *
6430     * @ingroup Gengrid
6431     */
6432    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6433
6434    /**
6435     * Get the gengrid object's handle which contains a given gengrid
6436     * item
6437     *
6438     * @param item The item to fetch the container from
6439     * @return The gengrid (parent) object
6440     *
6441     * This returns the gengrid object itself that an item belongs to.
6442     *
6443     * @ingroup Gengrid
6444     */
6445    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6446
6447    /**
6448     * Remove a gengrid item from the its parent, deleting it.
6449     *
6450     * @param item The item to be removed.
6451     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6452     *
6453     * @see elm_gengrid_clear(), to remove all items in a gengrid at
6454     * once.
6455     *
6456     * @ingroup Gengrid
6457     */
6458    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6459
6460    /**
6461     * Update the contents of a given gengrid item
6462     *
6463     * @param item The gengrid item
6464     *
6465     * This updates an item by calling all the item class functions
6466     * again to get the icons, labels and states. Use this when the
6467     * original item data has changed and you want thta changes to be
6468     * reflected.
6469     *
6470     * @ingroup Gengrid
6471     */
6472    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6473    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6474    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6475
6476    /**
6477     * Return the data associated to a given gengrid item
6478     *
6479     * @param item The gengrid item.
6480     * @return the data associated to this item.
6481     *
6482     * This returns the @c data value passed on the
6483     * elm_gengrid_item_append() and related item addition calls.
6484     *
6485     * @see elm_gengrid_item_append()
6486     * @see elm_gengrid_item_data_set()
6487     *
6488     * @ingroup Gengrid
6489     */
6490    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6491
6492    /**
6493     * Set the data associated to a given gengrid item
6494     *
6495     * @param item The gengrid item
6496     * @param data The new data pointer to set on it
6497     *
6498     * This @b overrides the @c data value passed on the
6499     * elm_gengrid_item_append() and related item addition calls. This
6500     * function @b won't call elm_gengrid_item_update() automatically,
6501     * so you'd issue it afterwards if you want to hove the item
6502     * updated to reflect the that new data.
6503     *
6504     * @see elm_gengrid_item_data_get()
6505     *
6506     * @ingroup Gengrid
6507     */
6508    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6509
6510    /**
6511     * Get a given gengrid item's position, relative to the whole
6512     * gengrid's grid area.
6513     *
6514     * @param item The Gengrid item.
6515     * @param x Pointer to variable where to store the item's <b>row
6516     * number</b>.
6517     * @param y Pointer to variable where to store the item's <b>column
6518     * number</b>.
6519     *
6520     * This returns the "logical" position of the item whithin the
6521     * gengrid. For example, @c (0, 1) would stand for first row,
6522     * second column.
6523     *
6524     * @ingroup Gengrid
6525     */
6526    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6527
6528    /**
6529     * Set whether a given gengrid item is selected or not
6530     *
6531     * @param item The gengrid item
6532     * @param selected Use @c EINA_TRUE, to make it selected, @c
6533     * EINA_FALSE to make it unselected
6534     *
6535     * This sets the selected state of an item. If multi selection is
6536     * not enabled on the containing gengrid and @p selected is @c
6537     * EINA_TRUE, any other previously selected items will get
6538     * unselected in favor of this new one.
6539     *
6540     * @see elm_gengrid_item_selected_get()
6541     *
6542     * @ingroup Gengrid
6543     */
6544    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6545
6546    /**
6547     * Get whether a given gengrid item is selected or not
6548     *
6549     * @param item The gengrid item
6550     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6551     *
6552     * @see elm_gengrid_item_selected_set() for more details
6553     *
6554     * @ingroup Gengrid
6555     */
6556    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6557
6558    /**
6559     * Get the real Evas object created to implement the view of a
6560     * given gengrid item
6561     *
6562     * @param item The gengrid item.
6563     * @return the Evas object implementing this item's view.
6564     *
6565     * This returns the actual Evas object used to implement the
6566     * specified gengrid item's view. This may be @c NULL, as it may
6567     * not have been created or may have been deleted, at any time, by
6568     * the gengrid. <b>Do not modify this object</b> (move, resize,
6569     * show, hide, etc.), as the gengrid is controlling it. This
6570     * function is for querying, emitting custom signals or hooking
6571     * lower level callbacks for events on that object. Do not delete
6572     * this object under any circumstances.
6573     *
6574     * @see elm_gengrid_item_data_get()
6575     *
6576     * @ingroup Gengrid
6577     */
6578    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6579
6580    /**
6581     * Show the portion of a gengrid's internal grid containing a given
6582     * item, @b immediately.
6583     *
6584     * @param item The item to display
6585     *
6586     * This causes gengrid to @b redraw its viewport's contents to the
6587     * region contining the given @p item item, if it is not fully
6588     * visible.
6589     *
6590     * @see elm_gengrid_item_bring_in()
6591     *
6592     * @ingroup Gengrid
6593     */
6594    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6595
6596    /**
6597     * Animatedly bring in, to the visible are of a gengrid, a given
6598     * item on it.
6599     *
6600     * @param item The gengrid item to display
6601     *
6602     * This causes gengrig to jump to the given @p item item and show
6603     * it (by scrolling), if it is not fully visible. This will use
6604     * animation to do so and take a period of time to complete.
6605     *
6606     * @see elm_gengrid_item_show()
6607     *
6608     * @ingroup Gengrid
6609     */
6610    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6611
6612    /**
6613     * Set whether a given gengrid item is disabled or not.
6614     *
6615     * @param item The gengrid item
6616     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6617     * to enable it back.
6618     *
6619     * A disabled item cannot be selected or unselected. It will also
6620     * change its appearance, to signal the user it's disabled.
6621     *
6622     * @see elm_gengrid_item_disabled_get()
6623     *
6624     * @ingroup Gengrid
6625     */
6626    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6627
6628    /**
6629     * Get whether a given gengrid item is disabled or not.
6630     *
6631     * @param item The gengrid item
6632     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6633     * (and on errors).
6634     *
6635     * @see elm_gengrid_item_disabled_set() for more details
6636     *
6637     * @ingroup Gengrid
6638     */
6639    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6640
6641    /**
6642     * Set the text to be shown in a given gengrid item's tooltips.
6643     *
6644     * @param item The gengrid item
6645     * @param text The text to set in the content
6646     *
6647     * This call will setup the text to be used as tooltip to that item
6648     * (analogous to elm_object_tooltip_text_set(), but being item
6649     * tooltips with higher precedence than object tooltips). It can
6650     * have only one tooltip at a time, so any previous tooltip data
6651     * will get removed.
6652     *
6653     * @ingroup Gengrid
6654     */
6655    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6656
6657    /**
6658     * Set the content to be shown in a given gengrid item's tooltips
6659     *
6660     * @param item The gengrid item.
6661     * @param func The function returning the tooltip contents.
6662     * @param data What to provide to @a func as callback data/context.
6663     * @param del_cb Called when data is not needed anymore, either when
6664     *        another callback replaces @p func, the tooltip is unset with
6665     *        elm_gengrid_item_tooltip_unset() or the owner @p item
6666     *        dies. This callback receives as its first parameter the
6667     *        given @p data, being @c event_info the item handle.
6668     *
6669     * This call will setup the tooltip's contents to @p item
6670     * (analogous to elm_object_tooltip_content_cb_set(), but being
6671     * item tooltips with higher precedence than object tooltips). It
6672     * can have only one tooltip at a time, so any previous tooltip
6673     * content will get removed. @p func (with @p data) will be called
6674     * every time Elementary needs to show the tooltip and it should
6675     * return a valid Evas object, which will be fully managed by the
6676     * tooltip system, getting deleted when the tooltip is gone.
6677     *
6678     * @ingroup Gengrid
6679     */
6680    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);
6681
6682    /**
6683     * Unset a tooltip from a given gengrid item
6684     *
6685     * @param item gengrid item to remove a previously set tooltip from.
6686     *
6687     * This call removes any tooltip set on @p item. The callback
6688     * provided as @c del_cb to
6689     * elm_gengrid_item_tooltip_content_cb_set() will be called to
6690     * notify it is not used anymore (and have resources cleaned, if
6691     * need be).
6692     *
6693     * @see elm_gengrid_item_tooltip_content_cb_set()
6694     *
6695     * @ingroup Gengrid
6696     */
6697    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6698
6699    /**
6700     * Set a different @b style for a given gengrid item's tooltip.
6701     *
6702     * @param item gengrid item with tooltip set
6703     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6704     * "default", @c "transparent", etc)
6705     *
6706     * Tooltips can have <b>alternate styles</b> to be displayed on,
6707     * which are defined by the theme set on Elementary. This function
6708     * works analogously as elm_object_tooltip_style_set(), but here
6709     * applied only to gengrid item objects. The default style for
6710     * tooltips is @c "default".
6711     *
6712     * @note before you set a style you should define a tooltip with
6713     *       elm_gengrid_item_tooltip_content_cb_set() or
6714     *       elm_gengrid_item_tooltip_text_set()
6715     *
6716     * @see elm_gengrid_item_tooltip_style_get()
6717     *
6718     * @ingroup Gengrid
6719     */
6720    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6721
6722    /**
6723     * Get the style set a given gengrid item's tooltip.
6724     *
6725     * @param item gengrid item with tooltip already set on.
6726     * @return style the theme style in use, which defaults to
6727     *         "default". If the object does not have a tooltip set,
6728     *         then @c NULL is returned.
6729     *
6730     * @see elm_gengrid_item_tooltip_style_set() for more details
6731     *
6732     * @ingroup Gengrid
6733     */
6734    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6735    /**
6736     * @brief Disable size restrictions on an object's tooltip
6737     * @param item The tooltip's anchor object
6738     * @param disable If EINA_TRUE, size restrictions are disabled
6739     * @return EINA_FALSE on failure, EINA_TRUE on success
6740     *
6741     * This function allows a tooltip to expand beyond its parant window's canvas.
6742     * It will instead be limited only by the size of the display.
6743     */
6744    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6745    /**
6746     * @brief Retrieve size restriction state of an object's tooltip
6747     * @param item The tooltip's anchor object
6748     * @return If EINA_TRUE, size restrictions are disabled
6749     *
6750     * This function returns whether a tooltip is allowed to expand beyond
6751     * its parant window's canvas.
6752     * It will instead be limited only by the size of the display.
6753     */
6754    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6755    /**
6756     * Set the type of mouse pointer/cursor decoration to be shown,
6757     * when the mouse pointer is over the given gengrid widget item
6758     *
6759     * @param item gengrid item to customize cursor on
6760     * @param cursor the cursor type's name
6761     *
6762     * This function works analogously as elm_object_cursor_set(), but
6763     * here the cursor's changing area is restricted to the item's
6764     * area, and not the whole widget's. Note that that item cursors
6765     * have precedence over widget cursors, so that a mouse over @p
6766     * item will always show cursor @p type.
6767     *
6768     * If this function is called twice for an object, a previously set
6769     * cursor will be unset on the second call.
6770     *
6771     * @see elm_object_cursor_set()
6772     * @see elm_gengrid_item_cursor_get()
6773     * @see elm_gengrid_item_cursor_unset()
6774     *
6775     * @ingroup Gengrid
6776     */
6777    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6778
6779    /**
6780     * Get the type of mouse pointer/cursor decoration set to be shown,
6781     * when the mouse pointer is over the given gengrid widget item
6782     *
6783     * @param item gengrid item with custom cursor set
6784     * @return the cursor type's name or @c NULL, if no custom cursors
6785     * were set to @p item (and on errors)
6786     *
6787     * @see elm_object_cursor_get()
6788     * @see elm_gengrid_item_cursor_set() for more details
6789     * @see elm_gengrid_item_cursor_unset()
6790     *
6791     * @ingroup Gengrid
6792     */
6793    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6794
6795    /**
6796     * Unset any custom mouse pointer/cursor decoration set to be
6797     * shown, when the mouse pointer is over the given gengrid widget
6798     * item, thus making it show the @b default cursor again.
6799     *
6800     * @param item a gengrid item
6801     *
6802     * Use this call to undo any custom settings on this item's cursor
6803     * decoration, bringing it back to defaults (no custom style set).
6804     *
6805     * @see elm_object_cursor_unset()
6806     * @see elm_gengrid_item_cursor_set() for more details
6807     *
6808     * @ingroup Gengrid
6809     */
6810    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6811
6812    /**
6813     * Set a different @b style for a given custom cursor set for a
6814     * gengrid item.
6815     *
6816     * @param item gengrid item with custom cursor set
6817     * @param style the <b>theme style</b> to use (e.g. @c "default",
6818     * @c "transparent", etc)
6819     *
6820     * This function only makes sense when one is using custom mouse
6821     * cursor decorations <b>defined in a theme file</b> , which can
6822     * have, given a cursor name/type, <b>alternate styles</b> on
6823     * it. It works analogously as elm_object_cursor_style_set(), but
6824     * here applied only to gengrid item objects.
6825     *
6826     * @warning Before you set a cursor style you should have defined a
6827     *       custom cursor previously on the item, with
6828     *       elm_gengrid_item_cursor_set()
6829     *
6830     * @see elm_gengrid_item_cursor_engine_only_set()
6831     * @see elm_gengrid_item_cursor_style_get()
6832     *
6833     * @ingroup Gengrid
6834     */
6835    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6836
6837    /**
6838     * Get the current @b style set for a given gengrid item's custom
6839     * cursor
6840     *
6841     * @param item gengrid item with custom cursor set.
6842     * @return style the cursor style in use. If the object does not
6843     *         have a cursor set, then @c NULL is returned.
6844     *
6845     * @see elm_gengrid_item_cursor_style_set() for more details
6846     *
6847     * @ingroup Gengrid
6848     */
6849    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6850
6851    /**
6852     * Set if the (custom) cursor for a given gengrid item should be
6853     * searched in its theme, also, or should only rely on the
6854     * rendering engine.
6855     *
6856     * @param item item with custom (custom) cursor already set on
6857     * @param engine_only Use @c EINA_TRUE to have cursors looked for
6858     * only on those provided by the rendering engine, @c EINA_FALSE to
6859     * have them searched on the widget's theme, as well.
6860     *
6861     * @note This call is of use only if you've set a custom cursor
6862     * for gengrid items, with elm_gengrid_item_cursor_set().
6863     *
6864     * @note By default, cursors will only be looked for between those
6865     * provided by the rendering engine.
6866     *
6867     * @ingroup Gengrid
6868     */
6869    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6870
6871    /**
6872     * Get if the (custom) cursor for a given gengrid item is being
6873     * searched in its theme, also, or is only relying on the rendering
6874     * engine.
6875     *
6876     * @param item a gengrid item
6877     * @return @c EINA_TRUE, if cursors are being looked for only on
6878     * those provided by the rendering engine, @c EINA_FALSE if they
6879     * are being searched on the widget's theme, as well.
6880     *
6881     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
6882     *
6883     * @ingroup Gengrid
6884     */
6885    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6886
6887    /**
6888     * Remove all items from a given gengrid widget
6889     *
6890     * @param obj The gengrid object.
6891     *
6892     * This removes (and deletes) all items in @p obj, leaving it
6893     * empty.
6894     *
6895     * @see elm_gengrid_item_del(), to remove just one item.
6896     *
6897     * @ingroup Gengrid
6898     */
6899    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6900
6901    /**
6902     * Get the selected item in a given gengrid widget
6903     *
6904     * @param obj The gengrid object.
6905     * @return The selected item's handleor @c NULL, if none is
6906     * selected at the moment (and on errors)
6907     *
6908     * This returns the selected item in @p obj. If multi selection is
6909     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
6910     * the first item in the list is selected, which might not be very
6911     * useful. For that case, see elm_gengrid_selected_items_get().
6912     *
6913     * @ingroup Gengrid
6914     */
6915    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6916
6917    /**
6918     * Get <b>a list</b> of selected items in a given gengrid
6919     *
6920     * @param obj The gengrid object.
6921     * @return The list of selected items or @c NULL, if none is
6922     * selected at the moment (and on errors)
6923     *
6924     * This returns a list of the selected items, in the order that
6925     * they appear in the grid. This list is only valid as long as no
6926     * more items are selected or unselected (or unselected implictly
6927     * by deletion). The list contains #Elm_Gengrid_Item pointers as
6928     * data, naturally.
6929     *
6930     * @see elm_gengrid_selected_item_get()
6931     *
6932     * @ingroup Gengrid
6933     */
6934    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6935
6936    /**
6937     * @}
6938     */
6939
6940    /**
6941     * @defgroup Clock Clock
6942     *
6943     * @image html img/widget/clock/preview-00.png
6944     * @image latex img/widget/clock/preview-00.eps
6945     *
6946     * This is a @b digital clock widget. In its default theme, it has a
6947     * vintage "flipping numbers clock" appearance, which will animate
6948     * sheets of individual algarisms individually as time goes by.
6949     *
6950     * A newly created clock will fetch system's time (already
6951     * considering local time adjustments) to start with, and will tick
6952     * accondingly. It may or may not show seconds.
6953     *
6954     * Clocks have an @b edition mode. When in it, the sheets will
6955     * display extra arrow indications on the top and bottom and the
6956     * user may click on them to raise or lower the time values. After
6957     * it's told to exit edition mode, it will keep ticking with that
6958     * new time set (it keeps the difference from local time).
6959     *
6960     * Also, when under edition mode, user clicks on the cited arrows
6961     * which are @b held for some time will make the clock to flip the
6962     * sheet, thus editing the time, continuosly and automatically for
6963     * the user. The interval between sheet flips will keep growing in
6964     * time, so that it helps the user to reach a time which is distant
6965     * from the one set.
6966     *
6967     * The time display is, by default, in military mode (24h), but an
6968     * am/pm indicator may be optionally shown, too, when it will
6969     * switch to 12h.
6970     *
6971     * Smart callbacks one can register to:
6972     * - "changed" - the clock's user changed the time
6973     *
6974     * Here is an example on its usage:
6975     * @li @ref clock_example
6976     */
6977
6978    /**
6979     * @addtogroup Clock
6980     * @{
6981     */
6982
6983    /**
6984     * Identifiers for which clock digits should be editable, when a
6985     * clock widget is in edition mode. Values may be ORed together to
6986     * make a mask, naturally.
6987     *
6988     * @see elm_clock_edit_set()
6989     * @see elm_clock_digit_edit_set()
6990     */
6991    typedef enum _Elm_Clock_Digedit
6992      {
6993         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
6994         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
6995         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
6996         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
6997         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
6998         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
6999         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
7000         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
7001      } Elm_Clock_Digedit;
7002
7003    /**
7004     * Add a new clock widget to the given parent Elementary
7005     * (container) object
7006     *
7007     * @param parent The parent object
7008     * @return a new clock widget handle or @c NULL, on errors
7009     *
7010     * This function inserts a new clock widget on the canvas.
7011     *
7012     * @ingroup Clock
7013     */
7014    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7015
7016    /**
7017     * Set a clock widget's time, programmatically
7018     *
7019     * @param obj The clock widget object
7020     * @param hrs The hours to set
7021     * @param min The minutes to set
7022     * @param sec The secondes to set
7023     *
7024     * This function updates the time that is showed by the clock
7025     * widget.
7026     *
7027     *  Values @b must be set within the following ranges:
7028     * - 0 - 23, for hours
7029     * - 0 - 59, for minutes
7030     * - 0 - 59, for seconds,
7031     *
7032     * even if the clock is not in "military" mode.
7033     *
7034     * @warning The behavior for values set out of those ranges is @b
7035     * indefined.
7036     *
7037     * @ingroup Clock
7038     */
7039    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7040
7041    /**
7042     * Get a clock widget's time values
7043     *
7044     * @param obj The clock object
7045     * @param[out] hrs Pointer to the variable to get the hours value
7046     * @param[out] min Pointer to the variable to get the minutes value
7047     * @param[out] sec Pointer to the variable to get the seconds value
7048     *
7049     * This function gets the time set for @p obj, returning
7050     * it on the variables passed as the arguments to function
7051     *
7052     * @note Use @c NULL pointers on the time values you're not
7053     * interested in: they'll be ignored by the function.
7054     *
7055     * @ingroup Clock
7056     */
7057    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7058
7059    /**
7060     * Set whether a given clock widget is under <b>edition mode</b> or
7061     * under (default) displaying-only mode.
7062     *
7063     * @param obj The clock object
7064     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7065     * put it back to "displaying only" mode
7066     *
7067     * This function makes a clock's time to be editable or not <b>by
7068     * user interaction</b>. When in edition mode, clocks @b stop
7069     * ticking, until one brings them back to canonical mode. The
7070     * elm_clock_digit_edit_set() function will influence which digits
7071     * of the clock will be editable. By default, all of them will be
7072     * (#ELM_CLOCK_NONE).
7073     *
7074     * @note am/pm sheets, if being shown, will @b always be editable
7075     * under edition mode.
7076     *
7077     * @see elm_clock_edit_get()
7078     *
7079     * @ingroup Clock
7080     */
7081    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7082
7083    /**
7084     * Retrieve whether a given clock widget is under <b>edition
7085     * mode</b> or under (default) displaying-only mode.
7086     *
7087     * @param obj The clock object
7088     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7089     * otherwise
7090     *
7091     * This function retrieves whether the clock's time can be edited
7092     * or not by user interaction.
7093     *
7094     * @see elm_clock_edit_set() for more details
7095     *
7096     * @ingroup Clock
7097     */
7098    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7099
7100    /**
7101     * Set what digits of the given clock widget should be editable
7102     * when in edition mode.
7103     *
7104     * @param obj The clock object
7105     * @param digedit Bit mask indicating the digits to be editable
7106     * (values in #Elm_Clock_Digedit).
7107     *
7108     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7109     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7110     * EINA_FALSE).
7111     *
7112     * @see elm_clock_digit_edit_get()
7113     *
7114     * @ingroup Clock
7115     */
7116    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7117
7118    /**
7119     * Retrieve what digits of the given clock widget should be
7120     * editable when in edition mode.
7121     *
7122     * @param obj The clock object
7123     * @return Bit mask indicating the digits to be editable
7124     * (values in #Elm_Clock_Digedit).
7125     *
7126     * @see elm_clock_digit_edit_set() for more details
7127     *
7128     * @ingroup Clock
7129     */
7130    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7131
7132    /**
7133     * Set if the given clock widget must show hours in military or
7134     * am/pm mode
7135     *
7136     * @param obj The clock object
7137     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7138     * to military mode
7139     *
7140     * This function sets if the clock must show hours in military or
7141     * am/pm mode. In some countries like Brazil the military mode
7142     * (00-24h-format) is used, in opposition to the USA, where the
7143     * am/pm mode is more commonly used.
7144     *
7145     * @see elm_clock_show_am_pm_get()
7146     *
7147     * @ingroup Clock
7148     */
7149    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7150
7151    /**
7152     * Get if the given clock widget shows hours in military or am/pm
7153     * mode
7154     *
7155     * @param obj The clock object
7156     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7157     * military
7158     *
7159     * This function gets if the clock shows hours in military or am/pm
7160     * mode.
7161     *
7162     * @see elm_clock_show_am_pm_set() for more details
7163     *
7164     * @ingroup Clock
7165     */
7166    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7167
7168    /**
7169     * Set if the given clock widget must show time with seconds or not
7170     *
7171     * @param obj The clock object
7172     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7173     *
7174     * This function sets if the given clock must show or not elapsed
7175     * seconds. By default, they are @b not shown.
7176     *
7177     * @see elm_clock_show_seconds_get()
7178     *
7179     * @ingroup Clock
7180     */
7181    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7182
7183    /**
7184     * Get whether the given clock widget is showing time with seconds
7185     * or not
7186     *
7187     * @param obj The clock object
7188     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7189     *
7190     * This function gets whether @p obj is showing or not the elapsed
7191     * seconds.
7192     *
7193     * @see elm_clock_show_seconds_set()
7194     *
7195     * @ingroup Clock
7196     */
7197    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7198
7199    /**
7200     * Set the interval on time updates for an user mouse button hold
7201     * on clock widgets' time edition.
7202     *
7203     * @param obj The clock object
7204     * @param interval The (first) interval value in seconds
7205     *
7206     * This interval value is @b decreased while the user holds the
7207     * mouse pointer either incrementing or decrementing a given the
7208     * clock digit's value.
7209     *
7210     * This helps the user to get to a given time distant from the
7211     * current one easier/faster, as it will start to flip quicker and
7212     * quicker on mouse button holds.
7213     *
7214     * The calculation for the next flip interval value, starting from
7215     * the one set with this call, is the previous interval divided by
7216     * 1.05, so it decreases a little bit.
7217     *
7218     * The default starting interval value for automatic flips is
7219     * @b 0.85 seconds.
7220     *
7221     * @see elm_clock_interval_get()
7222     *
7223     * @ingroup Clock
7224     */
7225    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7226
7227    /**
7228     * Get the interval on time updates for an user mouse button hold
7229     * on clock widgets' time edition.
7230     *
7231     * @param obj The clock object
7232     * @return The (first) interval value, in seconds, set on it
7233     *
7234     * @see elm_clock_interval_set() for more details
7235     *
7236     * @ingroup Clock
7237     */
7238    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7239
7240    /**
7241     * @}
7242     */
7243
7244    /**
7245     * @defgroup Layout Layout
7246     *
7247     * @image html img/widget/layout/preview-00.png
7248     * @image latex img/widget/layout/preview-00.eps width=\textwidth
7249     *
7250     * @image html img/layout-predefined.png
7251     * @image latex img/layout-predefined.eps width=\textwidth
7252     *
7253     * This is a container widget that takes a standard Edje design file and
7254     * wraps it very thinly in a widget.
7255     *
7256     * An Edje design (theme) file has a very wide range of possibilities to
7257     * describe the behavior of elements added to the Layout. Check out the Edje
7258     * documentation and the EDC reference to get more information about what can
7259     * be done with Edje.
7260     *
7261     * Just like @ref List, @ref Box, and other container widgets, any
7262     * object added to the Layout will become its child, meaning that it will be
7263     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7264     *
7265     * The Layout widget can contain as many Contents, Boxes or Tables as
7266     * described in its theme file. For instance, objects can be added to
7267     * different Tables by specifying the respective Table part names. The same
7268     * is valid for Content and Box.
7269     *
7270     * The objects added as child of the Layout will behave as described in the
7271     * part description where they were added. There are 3 possible types of
7272     * parts where a child can be added:
7273     *
7274     * @section secContent Content (SWALLOW part)
7275     *
7276     * Only one object can be added to the @c SWALLOW part (but you still can
7277     * have many @c SWALLOW parts and one object on each of them). Use the @c
7278     * elm_layout_content_* set of functions to set, retrieve and unset objects
7279     * as content of the @c SWALLOW. After being set to this part, the object
7280     * size, position, visibility, clipping and other description properties
7281     * will be totally controled by the description of the given part (inside
7282     * the Edje theme file).
7283     *
7284     * One can use @c evas_object_size_hint_* functions on the child to have some
7285     * kind of control over its behavior, but the resulting behavior will still
7286     * depend heavily on the @c SWALLOW part description.
7287     *
7288     * The Edje theme also can change the part description, based on signals or
7289     * scripts running inside the theme. This change can also be animated. All of
7290     * this will affect the child object set as content accordingly. The object
7291     * size will be changed if the part size is changed, it will animate move if
7292     * the part is moving, and so on.
7293     *
7294     * The following picture demonstrates a Layout widget with a child object
7295     * added to its @c SWALLOW:
7296     *
7297     * @image html layout_swallow.png
7298     * @image latex layout_swallow.eps width=\textwidth
7299     *
7300     * @section secBox Box (BOX part)
7301     *
7302     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7303     * allows one to add objects to the box and have them distributed along its
7304     * area, accordingly to the specified @a layout property (now by @a layout we
7305     * mean the chosen layouting design of the Box, not the Layout widget
7306     * itself).
7307     *
7308     * A similar effect for having a box with its position, size and other things
7309     * controled by the Layout theme would be to create an Elementary @ref Box
7310     * widget and add it as a Content in the @c SWALLOW part.
7311     *
7312     * The main difference of using the Layout Box is that its behavior, the box
7313     * properties like layouting format, padding, align, etc. will be all
7314     * controled by the theme. This means, for example, that a signal could be
7315     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7316     * handled the signal by changing the box padding, or align, or both. Using
7317     * the Elementary @ref Box widget is not necessarily harder or easier, it
7318     * just depends on the circunstances and requirements.
7319     *
7320     * The Layout Box can be used through the @c elm_layout_box_* set of
7321     * functions.
7322     *
7323     * The following picture demonstrates a Layout widget with many child objects
7324     * added to its @c BOX part:
7325     *
7326     * @image html layout_box.png
7327     * @image latex layout_box.eps width=\textwidth
7328     *
7329     * @section secTable Table (TABLE part)
7330     *
7331     * Just like the @ref secBox, the Layout Table is very similar to the
7332     * Elementary @ref Table widget. It allows one to add objects to the Table
7333     * specifying the row and column where the object should be added, and any
7334     * column or row span if necessary.
7335     *
7336     * Again, we could have this design by adding a @ref Table widget to the @c
7337     * SWALLOW part using elm_layout_content_set(). The same difference happens
7338     * here when choosing to use the Layout Table (a @c TABLE part) instead of
7339     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7340     *
7341     * The Layout Table can be used through the @c elm_layout_table_* set of
7342     * functions.
7343     *
7344     * The following picture demonstrates a Layout widget with many child objects
7345     * added to its @c TABLE part:
7346     *
7347     * @image html layout_table.png
7348     * @image latex layout_table.eps width=\textwidth
7349     *
7350     * @section secPredef Predefined Layouts
7351     *
7352     * Another interesting thing about the Layout widget is that it offers some
7353     * predefined themes that come with the default Elementary theme. These
7354     * themes can be set by the call elm_layout_theme_set(), and provide some
7355     * basic functionality depending on the theme used.
7356     *
7357     * Most of them already send some signals, some already provide a toolbar or
7358     * back and next buttons.
7359     *
7360     * These are available predefined theme layouts. All of them have class = @c
7361     * layout, group = @c application, and style = one of the following options:
7362     *
7363     * @li @c toolbar-content - application with toolbar and main content area
7364     * @li @c toolbar-content-back - application with toolbar and main content
7365     * area with a back button and title area
7366     * @li @c toolbar-content-back-next - application with toolbar and main
7367     * content area with a back and next buttons and title area
7368     * @li @c content-back - application with a main content area with a back
7369     * button and title area
7370     * @li @c content-back-next - application with a main content area with a
7371     * back and next buttons and title area
7372     * @li @c toolbar-vbox - application with toolbar and main content area as a
7373     * vertical box
7374     * @li @c toolbar-table - application with toolbar and main content area as a
7375     * table
7376     *
7377     * @section secExamples Examples
7378     *
7379     * Some examples of the Layout widget can be found here:
7380     * @li @ref layout_example_01
7381     * @li @ref layout_example_02
7382     * @li @ref layout_example_03
7383     * @li @ref layout_example_edc
7384     *
7385     */
7386
7387    /**
7388     * Add a new layout to the parent
7389     *
7390     * @param parent The parent object
7391     * @return The new object or NULL if it cannot be created
7392     *
7393     * @see elm_layout_file_set()
7394     * @see elm_layout_theme_set()
7395     *
7396     * @ingroup Layout
7397     */
7398    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7399    /**
7400     * Set the file that will be used as layout
7401     *
7402     * @param obj The layout object
7403     * @param file The path to file (edj) that will be used as layout
7404     * @param group The group that the layout belongs in edje file
7405     *
7406     * @return (1 = success, 0 = error)
7407     *
7408     * @ingroup Layout
7409     */
7410    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7411    /**
7412     * Set the edje group from the elementary theme that will be used as layout
7413     *
7414     * @param obj The layout object
7415     * @param clas the clas of the group
7416     * @param group the group
7417     * @param style the style to used
7418     *
7419     * @return (1 = success, 0 = error)
7420     *
7421     * @ingroup Layout
7422     */
7423    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7424    /**
7425     * Set the layout content.
7426     *
7427     * @param obj The layout object
7428     * @param swallow The swallow part name in the edje file
7429     * @param content The child that will be added in this layout object
7430     *
7431     * Once the content object is set, a previously set one will be deleted.
7432     * If you want to keep that old content object, use the
7433     * elm_layout_content_unset() function.
7434     *
7435     * @note In an Edje theme, the part used as a content container is called @c
7436     * SWALLOW. This is why the parameter name is called @p swallow, but it is
7437     * expected to be a part name just like the second parameter of
7438     * elm_layout_box_append().
7439     *
7440     * @see elm_layout_box_append()
7441     * @see elm_layout_content_get()
7442     * @see elm_layout_content_unset()
7443     * @see @ref secBox
7444     *
7445     * @ingroup Layout
7446     */
7447    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7448    /**
7449     * Get the child object in the given content part.
7450     *
7451     * @param obj The layout object
7452     * @param swallow The SWALLOW part to get its content
7453     *
7454     * @return The swallowed object or NULL if none or an error occurred
7455     *
7456     * @see elm_layout_content_set()
7457     *
7458     * @ingroup Layout
7459     */
7460    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7461    /**
7462     * Unset the layout content.
7463     *
7464     * @param obj The layout object
7465     * @param swallow The swallow part name in the edje file
7466     * @return The content that was being used
7467     *
7468     * Unparent and return the content object which was set for this part.
7469     *
7470     * @see elm_layout_content_set()
7471     *
7472     * @ingroup Layout
7473     */
7474     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7475    /**
7476     * Set the text of the given part
7477     *
7478     * @param obj The layout object
7479     * @param part The TEXT part where to set the text
7480     * @param text The text to set
7481     *
7482     * @ingroup Layout
7483     * @deprecated use elm_object_text_* instead.
7484     */
7485    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7486    /**
7487     * Get the text set in the given part
7488     *
7489     * @param obj The layout object
7490     * @param part The TEXT part to retrieve the text off
7491     *
7492     * @return The text set in @p part
7493     *
7494     * @ingroup Layout
7495     * @deprecated use elm_object_text_* instead.
7496     */
7497    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7498    /**
7499     * Append child to layout box part.
7500     *
7501     * @param obj the layout object
7502     * @param part the box part to which the object will be appended.
7503     * @param child the child object to append to box.
7504     *
7505     * Once the object is appended, it will become child of the layout. Its
7506     * lifetime will be bound to the layout, whenever the layout dies the child
7507     * will be deleted automatically. One should use elm_layout_box_remove() to
7508     * make this layout forget about the object.
7509     *
7510     * @see elm_layout_box_prepend()
7511     * @see elm_layout_box_insert_before()
7512     * @see elm_layout_box_insert_at()
7513     * @see elm_layout_box_remove()
7514     *
7515     * @ingroup Layout
7516     */
7517    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7518    /**
7519     * Prepend child to layout box part.
7520     *
7521     * @param obj the layout object
7522     * @param part the box part to prepend.
7523     * @param child the child object to prepend to box.
7524     *
7525     * Once the object is prepended, it will become child of the layout. Its
7526     * lifetime will be bound to the layout, whenever the layout dies the child
7527     * will be deleted automatically. One should use elm_layout_box_remove() to
7528     * make this layout forget about the object.
7529     *
7530     * @see elm_layout_box_append()
7531     * @see elm_layout_box_insert_before()
7532     * @see elm_layout_box_insert_at()
7533     * @see elm_layout_box_remove()
7534     *
7535     * @ingroup Layout
7536     */
7537    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7538    /**
7539     * Insert child to layout box part before a reference object.
7540     *
7541     * @param obj the layout object
7542     * @param part the box part to insert.
7543     * @param child the child object to insert into box.
7544     * @param reference another reference object to insert before in box.
7545     *
7546     * Once the object is inserted, it will become child of the layout. Its
7547     * lifetime will be bound to the layout, whenever the layout dies the child
7548     * will be deleted automatically. One should use elm_layout_box_remove() to
7549     * make this layout forget about the object.
7550     *
7551     * @see elm_layout_box_append()
7552     * @see elm_layout_box_prepend()
7553     * @see elm_layout_box_insert_before()
7554     * @see elm_layout_box_remove()
7555     *
7556     * @ingroup Layout
7557     */
7558    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7559    /**
7560     * Insert child to layout box part at a given position.
7561     *
7562     * @param obj the layout object
7563     * @param part the box part to insert.
7564     * @param child the child object to insert into box.
7565     * @param pos the numeric position >=0 to insert the child.
7566     *
7567     * Once the object is inserted, it will become child of the layout. Its
7568     * lifetime will be bound to the layout, whenever the layout dies the child
7569     * will be deleted automatically. One should use elm_layout_box_remove() to
7570     * make this layout forget about the object.
7571     *
7572     * @see elm_layout_box_append()
7573     * @see elm_layout_box_prepend()
7574     * @see elm_layout_box_insert_before()
7575     * @see elm_layout_box_remove()
7576     *
7577     * @ingroup Layout
7578     */
7579    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7580    /**
7581     * Remove a child of the given part box.
7582     *
7583     * @param obj The layout object
7584     * @param part The box part name to remove child.
7585     * @param child The object to remove from box.
7586     * @return The object that was being used, or NULL if not found.
7587     *
7588     * The object will be removed from the box part and its lifetime will
7589     * not be handled by the layout anymore. This is equivalent to
7590     * elm_layout_content_unset() for box.
7591     *
7592     * @see elm_layout_box_append()
7593     * @see elm_layout_box_remove_all()
7594     *
7595     * @ingroup Layout
7596     */
7597    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7598    /**
7599     * Remove all child of the given part box.
7600     *
7601     * @param obj The layout object
7602     * @param part The box part name to remove child.
7603     * @param clear If EINA_TRUE, then all objects will be deleted as
7604     *        well, otherwise they will just be removed and will be
7605     *        dangling on the canvas.
7606     *
7607     * The objects will be removed from the box part and their lifetime will
7608     * not be handled by the layout anymore. This is equivalent to
7609     * elm_layout_box_remove() for all box children.
7610     *
7611     * @see elm_layout_box_append()
7612     * @see elm_layout_box_remove()
7613     *
7614     * @ingroup Layout
7615     */
7616    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7617    /**
7618     * Insert child to layout table part.
7619     *
7620     * @param obj the layout object
7621     * @param part the box part to pack child.
7622     * @param child_obj the child object to pack into table.
7623     * @param col the column to which the child should be added. (>= 0)
7624     * @param row the row to which the child should be added. (>= 0)
7625     * @param colspan how many columns should be used to store this object. (>=
7626     *        1)
7627     * @param rowspan how many rows should be used to store this object. (>= 1)
7628     *
7629     * Once the object is inserted, it will become child of the table. Its
7630     * lifetime will be bound to the layout, and whenever the layout dies the
7631     * child will be deleted automatically. One should use
7632     * elm_layout_table_remove() to make this layout forget about the object.
7633     *
7634     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7635     * more space than a single cell. For instance, the following code:
7636     * @code
7637     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7638     * @endcode
7639     *
7640     * Would result in an object being added like the following picture:
7641     *
7642     * @image html layout_colspan.png
7643     * @image latex layout_colspan.eps width=\textwidth
7644     *
7645     * @see elm_layout_table_unpack()
7646     * @see elm_layout_table_clear()
7647     *
7648     * @ingroup Layout
7649     */
7650    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);
7651    /**
7652     * Unpack (remove) a child of the given part table.
7653     *
7654     * @param obj The layout object
7655     * @param part The table part name to remove child.
7656     * @param child_obj The object to remove from table.
7657     * @return The object that was being used, or NULL if not found.
7658     *
7659     * The object will be unpacked from the table part and its lifetime
7660     * will not be handled by the layout anymore. This is equivalent to
7661     * elm_layout_content_unset() for table.
7662     *
7663     * @see elm_layout_table_pack()
7664     * @see elm_layout_table_clear()
7665     *
7666     * @ingroup Layout
7667     */
7668    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7669    /**
7670     * Remove all child of the given part table.
7671     *
7672     * @param obj The layout object
7673     * @param part The table part name to remove child.
7674     * @param clear If EINA_TRUE, then all objects will be deleted as
7675     *        well, otherwise they will just be removed and will be
7676     *        dangling on the canvas.
7677     *
7678     * The objects will be removed from the table part and their lifetime will
7679     * not be handled by the layout anymore. This is equivalent to
7680     * elm_layout_table_unpack() for all table children.
7681     *
7682     * @see elm_layout_table_pack()
7683     * @see elm_layout_table_unpack()
7684     *
7685     * @ingroup Layout
7686     */
7687    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7688    /**
7689     * Get the edje layout
7690     *
7691     * @param obj The layout object
7692     *
7693     * @return A Evas_Object with the edje layout settings loaded
7694     * with function elm_layout_file_set
7695     *
7696     * This returns the edje object. It is not expected to be used to then
7697     * swallow objects via edje_object_part_swallow() for example. Use
7698     * elm_layout_content_set() instead so child object handling and sizing is
7699     * done properly.
7700     *
7701     * @note This function should only be used if you really need to call some
7702     * low level Edje function on this edje object. All the common stuff (setting
7703     * text, emitting signals, hooking callbacks to signals, etc.) can be done
7704     * with proper elementary functions.
7705     *
7706     * @see elm_object_signal_callback_add()
7707     * @see elm_object_signal_emit()
7708     * @see elm_object_text_part_set()
7709     * @see elm_layout_content_set()
7710     * @see elm_layout_box_append()
7711     * @see elm_layout_table_pack()
7712     * @see elm_layout_data_get()
7713     *
7714     * @ingroup Layout
7715     */
7716    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7717    /**
7718     * Get the edje data from the given layout
7719     *
7720     * @param obj The layout object
7721     * @param key The data key
7722     *
7723     * @return The edje data string
7724     *
7725     * This function fetches data specified inside the edje theme of this layout.
7726     * This function return NULL if data is not found.
7727     *
7728     * In EDC this comes from a data block within the group block that @p
7729     * obj was loaded from. E.g.
7730     *
7731     * @code
7732     * collections {
7733     *   group {
7734     *     name: "a_group";
7735     *     data {
7736     *       item: "key1" "value1";
7737     *       item: "key2" "value2";
7738     *     }
7739     *   }
7740     * }
7741     * @endcode
7742     *
7743     * @ingroup Layout
7744     */
7745    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7746    /**
7747     * Eval sizing
7748     *
7749     * @param obj The layout object
7750     *
7751     * Manually forces a sizing re-evaluation. This is useful when the minimum
7752     * size required by the edje theme of this layout has changed. The change on
7753     * the minimum size required by the edje theme is not immediately reported to
7754     * the elementary layout, so one needs to call this function in order to tell
7755     * the widget (layout) that it needs to reevaluate its own size.
7756     *
7757     * The minimum size of the theme is calculated based on minimum size of
7758     * parts, the size of elements inside containers like box and table, etc. All
7759     * of this can change due to state changes, and that's when this function
7760     * should be called.
7761     *
7762     * Also note that a standard signal of "size,eval" "elm" emitted from the
7763     * edje object will cause this to happen too.
7764     *
7765     * @ingroup Layout
7766     */
7767    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7768    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7769    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7770    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7771    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7772    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7773    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);
7774    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7775 /**
7776  * @def elm_layout_icon_set
7777  * Convienience macro to set the icon object in a layout that follows the
7778  * Elementary naming convention for its parts.
7779  *
7780  * @ingroup Layout
7781  */
7782 #define elm_layout_icon_set(_ly, _obj) \
7783   do { \
7784     const char *sig; \
7785     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7786     if ((_obj)) sig = "elm,state,icon,visible"; \
7787     else sig = "elm,state,icon,hidden"; \
7788     elm_object_signal_emit((_ly), sig, "elm"); \
7789   } while (0)
7790
7791 /**
7792  * @def elm_layout_icon_get
7793  * Convienience macro to get the icon object from a layout that follows the
7794  * Elementary naming convention for its parts.
7795  *
7796  * @ingroup Layout
7797  */
7798 #define elm_layout_icon_get(_ly) \
7799   elm_layout_content_get((_ly), "elm.swallow.icon")
7800
7801 /**
7802  * @def elm_layout_end_set
7803  * Convienience macro to set the end object in a layout that follows the
7804  * Elementary naming convention for its parts.
7805  *
7806  * @ingroup Layout
7807  */
7808 #define elm_layout_end_set(_ly, _obj) \
7809   do { \
7810     const char *sig; \
7811     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7812     if ((_obj)) sig = "elm,state,end,visible"; \
7813     else sig = "elm,state,end,hidden"; \
7814     elm_object_signal_emit((_ly), sig, "elm"); \
7815   } while (0)
7816
7817 /**
7818  * @def elm_layout_end_get
7819  * Convienience macro to get the end object in a layout that follows the
7820  * Elementary naming convention for its parts.
7821  *
7822  * @ingroup Layout
7823  */
7824 #define elm_layout_end_get(_ly) \
7825   elm_layout_content_get((_ly), "elm.swallow.end")
7826
7827 /**
7828  * @def elm_layout_label_set
7829  * Convienience macro to set the label in a layout that follows the
7830  * Elementary naming convention for its parts.
7831  *
7832  * @ingroup Layout
7833  * @deprecated use elm_object_text_* instead.
7834  */
7835 #define elm_layout_label_set(_ly, _txt) \
7836   elm_layout_text_set((_ly), "elm.text", (_txt))
7837
7838 /**
7839  * @def elm_layout_label_get
7840  * Convienience macro to get the label in a layout that follows the
7841  * Elementary naming convention for its parts.
7842  *
7843  * @ingroup Layout
7844  * @deprecated use elm_object_text_* instead.
7845  */
7846 #define elm_layout_label_get(_ly) \
7847   elm_layout_text_get((_ly), "elm.text")
7848
7849    /* smart callbacks called:
7850     * "theme,changed" - when elm theme is changed.
7851     */
7852
7853    /**
7854     * @defgroup Notify Notify
7855     *
7856     * @image html img/widget/notify/preview-00.png
7857     * @image latex img/widget/notify/preview-00.eps
7858     *
7859     * Display a container in a particular region of the parent(top, bottom,
7860     * etc.  A timeout can be set to automatically hide the notify. This is so
7861     * that, after an evas_object_show() on a notify object, if a timeout was set
7862     * on it, it will @b automatically get hidden after that time.
7863     *
7864     * Signals that you can add callbacks for are:
7865     * @li "timeout" - when timeout happens on notify and it's hidden
7866     * @li "block,clicked" - when a click outside of the notify happens
7867     *
7868     * @ref tutorial_notify show usage of the API.
7869     *
7870     * @{
7871     */
7872    /**
7873     * @brief Possible orient values for notify.
7874     *
7875     * This values should be used in conjunction to elm_notify_orient_set() to
7876     * set the position in which the notify should appear(relative to its parent)
7877     * and in conjunction with elm_notify_orient_get() to know where the notify
7878     * is appearing.
7879     */
7880    typedef enum _Elm_Notify_Orient
7881      {
7882         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
7883         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
7884         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
7885         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
7886         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
7887         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
7888         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
7889         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
7890         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
7891         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
7892      } Elm_Notify_Orient;
7893    /**
7894     * @brief Add a new notify to the parent
7895     *
7896     * @param parent The parent object
7897     * @return The new object or NULL if it cannot be created
7898     */
7899    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7900    /**
7901     * @brief Set the content of the notify widget
7902     *
7903     * @param obj The notify object
7904     * @param content The content will be filled in this notify object
7905     *
7906     * Once the content object is set, a previously set one will be deleted. If
7907     * you want to keep that old content object, use the
7908     * elm_notify_content_unset() function.
7909     */
7910    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7911    /**
7912     * @brief Unset the content of the notify widget
7913     *
7914     * @param obj The notify object
7915     * @return The content that was being used
7916     *
7917     * Unparent and return the content object which was set for this widget
7918     *
7919     * @see elm_notify_content_set()
7920     */
7921    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7922    /**
7923     * @brief Return the content of the notify widget
7924     *
7925     * @param obj The notify object
7926     * @return The content that is being used
7927     *
7928     * @see elm_notify_content_set()
7929     */
7930    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7931    /**
7932     * @brief Set the notify parent
7933     *
7934     * @param obj The notify object
7935     * @param content The new parent
7936     *
7937     * Once the parent object is set, a previously set one will be disconnected
7938     * and replaced.
7939     */
7940    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7941    /**
7942     * @brief Get the notify parent
7943     *
7944     * @param obj The notify object
7945     * @return The parent
7946     *
7947     * @see elm_notify_parent_set()
7948     */
7949    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7950    /**
7951     * @brief Set the orientation
7952     *
7953     * @param obj The notify object
7954     * @param orient The new orientation
7955     *
7956     * Sets the position in which the notify will appear in its parent.
7957     *
7958     * @see @ref Elm_Notify_Orient for possible values.
7959     */
7960    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
7961    /**
7962     * @brief Return the orientation
7963     * @param obj The notify object
7964     * @return The orientation of the notification
7965     *
7966     * @see elm_notify_orient_set()
7967     * @see Elm_Notify_Orient
7968     */
7969    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7970    /**
7971     * @brief Set the time interval after which the notify window is going to be
7972     * hidden.
7973     *
7974     * @param obj The notify object
7975     * @param time The timeout in seconds
7976     *
7977     * This function sets a timeout and starts the timer controlling when the
7978     * notify is hidden. Since calling evas_object_show() on a notify restarts
7979     * the timer controlling when the notify is hidden, setting this before the
7980     * notify is shown will in effect mean starting the timer when the notify is
7981     * shown.
7982     *
7983     * @note Set a value <= 0.0 to disable a running timer.
7984     *
7985     * @note If the value > 0.0 and the notify is previously visible, the
7986     * timer will be started with this value, canceling any running timer.
7987     */
7988    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7989    /**
7990     * @brief Return the timeout value (in seconds)
7991     * @param obj the notify object
7992     *
7993     * @see elm_notify_timeout_set()
7994     */
7995    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7996    /**
7997     * @brief Sets whether events should be passed to by a click outside
7998     * its area.
7999     *
8000     * @param obj The notify object
8001     * @param repeats EINA_TRUE Events are repeats, else no
8002     *
8003     * When true if the user clicks outside the window the events will be caught
8004     * by the others widgets, else the events are blocked.
8005     *
8006     * @note The default value is EINA_TRUE.
8007     */
8008    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
8009    /**
8010     * @brief Return true if events are repeat below the notify object
8011     * @param obj the notify object
8012     *
8013     * @see elm_notify_repeat_events_set()
8014     */
8015    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8016    /**
8017     * @}
8018     */
8019
8020    /**
8021     * @defgroup Hover Hover
8022     *
8023     * @image html img/widget/hover/preview-00.png
8024     * @image latex img/widget/hover/preview-00.eps
8025     *
8026     * A Hover object will hover over its @p parent object at the @p target
8027     * location. Anything in the background will be given a darker coloring to
8028     * indicate that the hover object is on top (at the default theme). When the
8029     * hover is clicked it is dismissed(hidden), if the contents of the hover are
8030     * clicked that @b doesn't cause the hover to be dismissed.
8031     *
8032     * @note The hover object will take up the entire space of @p target
8033     * object.
8034     *
8035     * Elementary has the following styles for the hover widget:
8036     * @li default
8037     * @li popout
8038     * @li menu
8039     * @li hoversel_vertical
8040     *
8041     * The following are the available position for content:
8042     * @li left
8043     * @li top-left
8044     * @li top
8045     * @li top-right
8046     * @li right
8047     * @li bottom-right
8048     * @li bottom
8049     * @li bottom-left
8050     * @li middle
8051     * @li smart
8052     *
8053     * Signals that you can add callbacks for are:
8054     * @li "clicked" - the user clicked the empty space in the hover to dismiss
8055     * @li "smart,changed" - a content object placed under the "smart"
8056     *                   policy was replaced to a new slot direction.
8057     *
8058     * See @ref tutorial_hover for more information.
8059     *
8060     * @{
8061     */
8062    typedef enum _Elm_Hover_Axis
8063      {
8064         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8065         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8066         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8067         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8068      } Elm_Hover_Axis;
8069    /**
8070     * @brief Adds a hover object to @p parent
8071     *
8072     * @param parent The parent object
8073     * @return The hover object or NULL if one could not be created
8074     */
8075    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8076    /**
8077     * @brief Sets the target object for the hover.
8078     *
8079     * @param obj The hover object
8080     * @param target The object to center the hover onto. The hover
8081     *
8082     * This function will cause the hover to be centered on the target object.
8083     */
8084    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8085    /**
8086     * @brief Gets the target object for the hover.
8087     *
8088     * @param obj The hover object
8089     * @param parent The object to locate the hover over.
8090     *
8091     * @see elm_hover_target_set()
8092     */
8093    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8094    /**
8095     * @brief Sets the parent object for the hover.
8096     *
8097     * @param obj The hover object
8098     * @param parent The object to locate the hover over.
8099     *
8100     * This function will cause the hover to take up the entire space that the
8101     * parent object fills.
8102     */
8103    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8104    /**
8105     * @brief Gets the parent object for the hover.
8106     *
8107     * @param obj The hover object
8108     * @return The parent object to locate the hover over.
8109     *
8110     * @see elm_hover_parent_set()
8111     */
8112    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8113    /**
8114     * @brief Sets the content of the hover object and the direction in which it
8115     * will pop out.
8116     *
8117     * @param obj The hover object
8118     * @param swallow The direction that the object will be displayed
8119     * at. Accepted values are "left", "top-left", "top", "top-right",
8120     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8121     * "smart".
8122     * @param content The content to place at @p swallow
8123     *
8124     * Once the content object is set for a given direction, a previously
8125     * set one (on the same direction) will be deleted. If you want to
8126     * keep that old content object, use the elm_hover_content_unset()
8127     * function.
8128     *
8129     * All directions may have contents at the same time, except for
8130     * "smart". This is a special placement hint and its use case
8131     * independs of the calculations coming from
8132     * elm_hover_best_content_location_get(). Its use is for cases when
8133     * one desires only one hover content, but with a dinamic special
8134     * placement within the hover area. The content's geometry, whenever
8135     * it changes, will be used to decide on a best location not
8136     * extrapolating the hover's parent object view to show it in (still
8137     * being the hover's target determinant of its medium part -- move and
8138     * resize it to simulate finger sizes, for example). If one of the
8139     * directions other than "smart" are used, a previously content set
8140     * using it will be deleted, and vice-versa.
8141     */
8142    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8143    /**
8144     * @brief Get the content of the hover object, in a given direction.
8145     *
8146     * Return the content object which was set for this widget in the
8147     * @p swallow direction.
8148     *
8149     * @param obj The hover object
8150     * @param swallow The direction that the object was display at.
8151     * @return The content that was being used
8152     *
8153     * @see elm_hover_content_set()
8154     */
8155    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8156    /**
8157     * @brief Unset the content of the hover object, in a given direction.
8158     *
8159     * Unparent and return the content object set at @p swallow direction.
8160     *
8161     * @param obj The hover object
8162     * @param swallow The direction that the object was display at.
8163     * @return The content that was being used.
8164     *
8165     * @see elm_hover_content_set()
8166     */
8167    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8168    /**
8169     * @brief Returns the best swallow location for content in the hover.
8170     *
8171     * @param obj The hover object
8172     * @param pref_axis The preferred orientation axis for the hover object to use
8173     * @return The edje location to place content into the hover or @c
8174     *         NULL, on errors.
8175     *
8176     * Best is defined here as the location at which there is the most available
8177     * space.
8178     *
8179     * @p pref_axis may be one of
8180     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8181     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8182     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8183     * - @c ELM_HOVER_AXIS_BOTH -- both
8184     *
8185     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8186     * nescessarily be along the horizontal axis("left" or "right"). If
8187     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8188     * be along the vertical axis("top" or "bottom"). Chossing
8189     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8190     * returned position may be in either axis.
8191     *
8192     * @see elm_hover_content_set()
8193     */
8194    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8195    /**
8196     * @}
8197     */
8198
8199    /* entry */
8200    /**
8201     * @defgroup Entry Entry
8202     *
8203     * @image html img/widget/entry/preview-00.png
8204     * @image latex img/widget/entry/preview-00.eps width=\textwidth
8205     * @image html img/widget/entry/preview-01.png
8206     * @image latex img/widget/entry/preview-01.eps width=\textwidth
8207     * @image html img/widget/entry/preview-02.png
8208     * @image latex img/widget/entry/preview-02.eps width=\textwidth
8209     * @image html img/widget/entry/preview-03.png
8210     * @image latex img/widget/entry/preview-03.eps width=\textwidth
8211     *
8212     * An entry is a convenience widget which shows a box that the user can
8213     * enter text into. Entries by default don't scroll, so they grow to
8214     * accomodate the entire text, resizing the parent window as needed. This
8215     * can be changed with the elm_entry_scrollable_set() function.
8216     *
8217     * They can also be single line or multi line (the default) and when set
8218     * to multi line mode they support text wrapping in any of the modes
8219     * indicated by #Elm_Wrap_Type.
8220     *
8221     * Other features include password mode, filtering of inserted text with
8222     * elm_entry_text_filter_append() and related functions, inline "items" and
8223     * formatted markup text.
8224     *
8225     * @section entry-markup Formatted text
8226     *
8227     * The markup tags supported by the Entry are defined by the theme, but
8228     * even when writing new themes or extensions it's a good idea to stick to
8229     * a sane default, to maintain coherency and avoid application breakages.
8230     * Currently defined by the default theme are the following tags:
8231     * @li \<br\>: Inserts a line break.
8232     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8233     * breaks.
8234     * @li \<tab\>: Inserts a tab.
8235     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8236     * enclosed text.
8237     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8238     * @li \<link\>...\</link\>: Underlines the enclosed text.
8239     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8240     *
8241     * @section entry-special Special markups
8242     *
8243     * Besides those used to format text, entries support two special markup
8244     * tags used to insert clickable portions of text or items inlined within
8245     * the text.
8246     *
8247     * @subsection entry-anchors Anchors
8248     *
8249     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8250     * \</a\> tags and an event will be generated when this text is clicked,
8251     * like this:
8252     *
8253     * @code
8254     * This text is outside <a href=anc-01>but this one is an anchor</a>
8255     * @endcode
8256     *
8257     * The @c href attribute in the opening tag gives the name that will be
8258     * used to identify the anchor and it can be any valid utf8 string.
8259     *
8260     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8261     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8262     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8263     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8264     * an anchor.
8265     *
8266     * @subsection entry-items Items
8267     *
8268     * Inlined in the text, any other @c Evas_Object can be inserted by using
8269     * \<item\> tags this way:
8270     *
8271     * @code
8272     * <item size=16x16 vsize=full href=emoticon/haha></item>
8273     * @endcode
8274     *
8275     * Just like with anchors, the @c href identifies each item, but these need,
8276     * in addition, to indicate their size, which is done using any one of
8277     * @c size, @c absize or @c relsize attributes. These attributes take their
8278     * value in the WxH format, where W is the width and H the height of the
8279     * item.
8280     *
8281     * @li absize: Absolute pixel size for the item. Whatever value is set will
8282     * be the item's size regardless of any scale value the object may have
8283     * been set to. The final line height will be adjusted to fit larger items.
8284     * @li size: Similar to @c absize, but it's adjusted to the scale value set
8285     * for the object.
8286     * @li relsize: Size is adjusted for the item to fit within the current
8287     * line height.
8288     *
8289     * Besides their size, items are specificed a @c vsize value that affects
8290     * how their final size and position are calculated. The possible values
8291     * are:
8292     * @li ascent: Item will be placed within the line's baseline and its
8293     * ascent. That is, the height between the line where all characters are
8294     * positioned and the highest point in the line. For @c size and @c absize
8295     * items, the descent value will be added to the total line height to make
8296     * them fit. @c relsize items will be adjusted to fit within this space.
8297     * @li full: Items will be placed between the descent and ascent, or the
8298     * lowest point in the line and its highest.
8299     *
8300     * The next image shows different configurations of items and how they
8301     * are the previously mentioned options affect their sizes. In all cases,
8302     * the green line indicates the ascent, blue for the baseline and red for
8303     * the descent.
8304     *
8305     * @image html entry_item.png
8306     * @image latex entry_item.eps width=\textwidth
8307     *
8308     * And another one to show how size differs from absize. In the first one,
8309     * the scale value is set to 1.0, while the second one is using one of 2.0.
8310     *
8311     * @image html entry_item_scale.png
8312     * @image latex entry_item_scale.eps width=\textwidth
8313     *
8314     * After the size for an item is calculated, the entry will request an
8315     * object to place in its space. For this, the functions set with
8316     * elm_entry_item_provider_append() and related functions will be called
8317     * in order until one of them returns a @c non-NULL value. If no providers
8318     * are available, or all of them return @c NULL, then the entry falls back
8319     * to one of the internal defaults, provided the name matches with one of
8320     * them.
8321     *
8322     * All of the following are currently supported:
8323     *
8324     * - emoticon/angry
8325     * - emoticon/angry-shout
8326     * - emoticon/crazy-laugh
8327     * - emoticon/evil-laugh
8328     * - emoticon/evil
8329     * - emoticon/goggle-smile
8330     * - emoticon/grumpy
8331     * - emoticon/grumpy-smile
8332     * - emoticon/guilty
8333     * - emoticon/guilty-smile
8334     * - emoticon/haha
8335     * - emoticon/half-smile
8336     * - emoticon/happy-panting
8337     * - emoticon/happy
8338     * - emoticon/indifferent
8339     * - emoticon/kiss
8340     * - emoticon/knowing-grin
8341     * - emoticon/laugh
8342     * - emoticon/little-bit-sorry
8343     * - emoticon/love-lots
8344     * - emoticon/love
8345     * - emoticon/minimal-smile
8346     * - emoticon/not-happy
8347     * - emoticon/not-impressed
8348     * - emoticon/omg
8349     * - emoticon/opensmile
8350     * - emoticon/smile
8351     * - emoticon/sorry
8352     * - emoticon/squint-laugh
8353     * - emoticon/surprised
8354     * - emoticon/suspicious
8355     * - emoticon/tongue-dangling
8356     * - emoticon/tongue-poke
8357     * - emoticon/uh
8358     * - emoticon/unhappy
8359     * - emoticon/very-sorry
8360     * - emoticon/what
8361     * - emoticon/wink
8362     * - emoticon/worried
8363     * - emoticon/wtf
8364     *
8365     * Alternatively, an item may reference an image by its path, using
8366     * the URI form @c file:///path/to/an/image.png and the entry will then
8367     * use that image for the item.
8368     *
8369     * @section entry-files Loading and saving files
8370     *
8371     * Entries have convinience functions to load text from a file and save
8372     * changes back to it after a short delay. The automatic saving is enabled
8373     * by default, but can be disabled with elm_entry_autosave_set() and files
8374     * can be loaded directly as plain text or have any markup in them
8375     * recognized. See elm_entry_file_set() for more details.
8376     *
8377     * @section entry-signals Emitted signals
8378     *
8379     * This widget emits the following signals:
8380     *
8381     * @li "changed": The text within the entry was changed.
8382     * @li "changed,user": The text within the entry was changed because of user interaction.
8383     * @li "activated": The enter key was pressed on a single line entry.
8384     * @li "press": A mouse button has been pressed on the entry.
8385     * @li "longpressed": A mouse button has been pressed and held for a couple
8386     * seconds.
8387     * @li "clicked": The entry has been clicked (mouse press and release).
8388     * @li "clicked,double": The entry has been double clicked.
8389     * @li "clicked,triple": The entry has been triple clicked.
8390     * @li "focused": The entry has received focus.
8391     * @li "unfocused": The entry has lost focus.
8392     * @li "selection,paste": A paste of the clipboard contents was requested.
8393     * @li "selection,copy": A copy of the selected text into the clipboard was
8394     * requested.
8395     * @li "selection,cut": A cut of the selected text into the clipboard was
8396     * requested.
8397     * @li "selection,start": A selection has begun and no previous selection
8398     * existed.
8399     * @li "selection,changed": The current selection has changed.
8400     * @li "selection,cleared": The current selection has been cleared.
8401     * @li "cursor,changed": The cursor has changed position.
8402     * @li "anchor,clicked": An anchor has been clicked. The event_info
8403     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8404     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8405     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8406     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8407     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8408     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8409     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8410     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8411     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8412     * @li "preedit,changed": The preedit string has changed.
8413     *
8414     * @section entry-examples
8415     *
8416     * An overview of the Entry API can be seen in @ref entry_example_01
8417     *
8418     * @{
8419     */
8420    /**
8421     * @typedef Elm_Entry_Anchor_Info
8422     *
8423     * The info sent in the callback for the "anchor,clicked" signals emitted
8424     * by entries.
8425     */
8426    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8427    /**
8428     * @struct _Elm_Entry_Anchor_Info
8429     *
8430     * The info sent in the callback for the "anchor,clicked" signals emitted
8431     * by entries.
8432     */
8433    struct _Elm_Entry_Anchor_Info
8434      {
8435         const char *name; /**< The name of the anchor, as stated in its href */
8436         int         button; /**< The mouse button used to click on it */
8437         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
8438                     y, /**< Anchor geometry, relative to canvas */
8439                     w, /**< Anchor geometry, relative to canvas */
8440                     h; /**< Anchor geometry, relative to canvas */
8441      };
8442    /**
8443     * @typedef Elm_Entry_Filter_Cb
8444     * This callback type is used by entry filters to modify text.
8445     * @param data The data specified as the last param when adding the filter
8446     * @param entry The entry object
8447     * @param text A pointer to the location of the text being filtered. This data can be modified,
8448     * but any additional allocations must be managed by the user.
8449     * @see elm_entry_text_filter_append
8450     * @see elm_entry_text_filter_prepend
8451     */
8452    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8453
8454    /**
8455     * This adds an entry to @p parent object.
8456     *
8457     * By default, entries are:
8458     * @li not scrolled
8459     * @li multi-line
8460     * @li word wrapped
8461     * @li autosave is enabled
8462     *
8463     * @param parent The parent object
8464     * @return The new object or NULL if it cannot be created
8465     */
8466    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8467    /**
8468     * Sets the entry to single line mode.
8469     *
8470     * In single line mode, entries don't ever wrap when the text reaches the
8471     * edge, and instead they keep growing horizontally. Pressing the @c Enter
8472     * key will generate an @c "activate" event instead of adding a new line.
8473     *
8474     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8475     * and pressing enter will break the text into a different line
8476     * without generating any events.
8477     *
8478     * @param obj The entry object
8479     * @param single_line If true, the text in the entry
8480     * will be on a single line.
8481     */
8482    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8483    /**
8484     * Gets whether the entry is set to be single line.
8485     *
8486     * @param obj The entry object
8487     * @return single_line If true, the text in the entry is set to display
8488     * on a single line.
8489     *
8490     * @see elm_entry_single_line_set()
8491     */
8492    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8493    /**
8494     * Sets the entry to password mode.
8495     *
8496     * In password mode, entries are implicitly single line and the display of
8497     * any text in them is replaced with asterisks (*).
8498     *
8499     * @param obj The entry object
8500     * @param password If true, password mode is enabled.
8501     */
8502    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8503    /**
8504     * Gets whether the entry is set to password mode.
8505     *
8506     * @param obj The entry object
8507     * @return If true, the entry is set to display all characters
8508     * as asterisks (*).
8509     *
8510     * @see elm_entry_password_set()
8511     */
8512    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8513    /**
8514     * This sets the text displayed within the entry to @p entry.
8515     *
8516     * @param obj The entry object
8517     * @param entry The text to be displayed
8518     *
8519     * @deprecated Use elm_object_text_set() instead.
8520     */
8521    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8522    /**
8523     * This returns the text currently shown in object @p entry.
8524     * See also elm_entry_entry_set().
8525     *
8526     * @param obj The entry object
8527     * @return The currently displayed text or NULL on failure
8528     *
8529     * @deprecated Use elm_object_text_get() instead.
8530     */
8531    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8532    /**
8533     * Appends @p entry to the text of the entry.
8534     *
8535     * Adds the text in @p entry to the end of any text already present in the
8536     * widget.
8537     *
8538     * The appended text is subject to any filters set for the widget.
8539     *
8540     * @param obj The entry object
8541     * @param entry The text to be displayed
8542     *
8543     * @see elm_entry_text_filter_append()
8544     */
8545    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8546    /**
8547     * Gets whether the entry is empty.
8548     *
8549     * Empty means no text at all. If there are any markup tags, like an item
8550     * tag for which no provider finds anything, and no text is displayed, this
8551     * function still returns EINA_FALSE.
8552     *
8553     * @param obj The entry object
8554     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8555     */
8556    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8557    /**
8558     * Gets any selected text within the entry.
8559     *
8560     * If there's any selected text in the entry, this function returns it as
8561     * a string in markup format. NULL is returned if no selection exists or
8562     * if an error occurred.
8563     *
8564     * The returned value points to an internal string and should not be freed
8565     * or modified in any way. If the @p entry object is deleted or its
8566     * contents are changed, the returned pointer should be considered invalid.
8567     *
8568     * @param obj The entry object
8569     * @return The selected text within the entry or NULL on failure
8570     */
8571    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8572    /**
8573     * Inserts the given text into the entry at the current cursor position.
8574     *
8575     * This inserts text at the cursor position as if it was typed
8576     * by the user (note that this also allows markup which a user
8577     * can't just "type" as it would be converted to escaped text, so this
8578     * call can be used to insert things like emoticon items or bold push/pop
8579     * tags, other font and color change tags etc.)
8580     *
8581     * If any selection exists, it will be replaced by the inserted text.
8582     *
8583     * The inserted text is subject to any filters set for the widget.
8584     *
8585     * @param obj The entry object
8586     * @param entry The text to insert
8587     *
8588     * @see elm_entry_text_filter_append()
8589     */
8590    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8591    /**
8592     * Set the line wrap type to use on multi-line entries.
8593     *
8594     * Sets the wrap type used by the entry to any of the specified in
8595     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8596     * line (without inserting a line break or paragraph separator) when it
8597     * reaches the far edge of the widget.
8598     *
8599     * Note that this only makes sense for multi-line entries. A widget set
8600     * to be single line will never wrap.
8601     *
8602     * @param obj The entry object
8603     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8604     */
8605    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8606    /**
8607     * Gets the wrap mode the entry was set to use.
8608     *
8609     * @param obj The entry object
8610     * @return Wrap type
8611     *
8612     * @see also elm_entry_line_wrap_set()
8613     */
8614    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8615    /**
8616     * Sets if the entry is to be editable or not.
8617     *
8618     * By default, entries are editable and when focused, any text input by the
8619     * user will be inserted at the current cursor position. But calling this
8620     * function with @p editable as EINA_FALSE will prevent the user from
8621     * inputting text into the entry.
8622     *
8623     * The only way to change the text of a non-editable entry is to use
8624     * elm_object_text_set(), elm_entry_entry_insert() and other related
8625     * functions.
8626     *
8627     * @param obj The entry object
8628     * @param editable If EINA_TRUE, user input will be inserted in the entry,
8629     * if not, the entry is read-only and no user input is allowed.
8630     */
8631    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8632    /**
8633     * Gets whether the entry is editable or not.
8634     *
8635     * @param obj The entry object
8636     * @return If true, the entry is editable by the user.
8637     * If false, it is not editable by the user
8638     *
8639     * @see elm_entry_editable_set()
8640     */
8641    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8642    /**
8643     * This drops any existing text selection within the entry.
8644     *
8645     * @param obj The entry object
8646     */
8647    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8648    /**
8649     * This selects all text within the entry.
8650     *
8651     * @param obj The entry object
8652     */
8653    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8654    /**
8655     * This moves the cursor one place to the right within the entry.
8656     *
8657     * @param obj The entry object
8658     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8659     */
8660    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8661    /**
8662     * This moves the cursor one place to the left within the entry.
8663     *
8664     * @param obj The entry object
8665     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8666     */
8667    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8668    /**
8669     * This moves the cursor one line up within the entry.
8670     *
8671     * @param obj The entry object
8672     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8673     */
8674    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8675    /**
8676     * This moves the cursor one line down within the entry.
8677     *
8678     * @param obj The entry object
8679     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8680     */
8681    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8682    /**
8683     * This moves the cursor to the beginning of the entry.
8684     *
8685     * @param obj The entry object
8686     */
8687    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8688    /**
8689     * This moves the cursor to the end of the entry.
8690     *
8691     * @param obj The entry object
8692     */
8693    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8694    /**
8695     * This moves the cursor to the beginning of the current line.
8696     *
8697     * @param obj The entry object
8698     */
8699    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8700    /**
8701     * This moves the cursor to the end of the current line.
8702     *
8703     * @param obj The entry object
8704     */
8705    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8706    /**
8707     * This begins a selection within the entry as though
8708     * the user were holding down the mouse button to make a selection.
8709     *
8710     * @param obj The entry object
8711     */
8712    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8713    /**
8714     * This ends a selection within the entry as though
8715     * the user had just released the mouse button while making a selection.
8716     *
8717     * @param obj The entry object
8718     */
8719    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8720    /**
8721     * Gets whether a format node exists at the current cursor position.
8722     *
8723     * A format node is anything that defines how the text is rendered. It can
8724     * be a visible format node, such as a line break or a paragraph separator,
8725     * or an invisible one, such as bold begin or end tag.
8726     * This function returns whether any format node exists at the current
8727     * cursor position.
8728     *
8729     * @param obj The entry object
8730     * @return EINA_TRUE if the current cursor position contains a format node,
8731     * EINA_FALSE otherwise.
8732     *
8733     * @see elm_entry_cursor_is_visible_format_get()
8734     */
8735    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8736    /**
8737     * Gets if the current cursor position holds a visible format node.
8738     *
8739     * @param obj The entry object
8740     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8741     * if it's an invisible one or no format exists.
8742     *
8743     * @see elm_entry_cursor_is_format_get()
8744     */
8745    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8746    /**
8747     * Gets the character pointed by the cursor at its current position.
8748     *
8749     * This function returns a string with the utf8 character stored at the
8750     * current cursor position.
8751     * Only the text is returned, any format that may exist will not be part
8752     * of the return value.
8753     *
8754     * @param obj The entry object
8755     * @return The text pointed by the cursors.
8756     */
8757    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8758    /**
8759     * This function returns the geometry of the cursor.
8760     *
8761     * It's useful if you want to draw something on the cursor (or where it is),
8762     * or for example in the case of scrolled entry where you want to show the
8763     * cursor.
8764     *
8765     * @param obj The entry object
8766     * @param x returned geometry
8767     * @param y returned geometry
8768     * @param w returned geometry
8769     * @param h returned geometry
8770     * @return EINA_TRUE upon success, EINA_FALSE upon failure
8771     */
8772    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);
8773    /**
8774     * Sets the cursor position in the entry to the given value
8775     *
8776     * The value in @p pos is the index of the character position within the
8777     * contents of the string as returned by elm_entry_cursor_pos_get().
8778     *
8779     * @param obj The entry object
8780     * @param pos The position of the cursor
8781     */
8782    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8783    /**
8784     * Retrieves the current position of the cursor in the entry
8785     *
8786     * @param obj The entry object
8787     * @return The cursor position
8788     */
8789    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8790    /**
8791     * This executes a "cut" action on the selected text in the entry.
8792     *
8793     * @param obj The entry object
8794     */
8795    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8796    /**
8797     * This executes a "copy" action on the selected text in the entry.
8798     *
8799     * @param obj The entry object
8800     */
8801    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8802    /**
8803     * This executes a "paste" action in the entry.
8804     *
8805     * @param obj The entry object
8806     */
8807    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8808    /**
8809     * This clears and frees the items in a entry's contextual (longpress)
8810     * menu.
8811     *
8812     * @param obj The entry object
8813     *
8814     * @see elm_entry_context_menu_item_add()
8815     */
8816    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8817    /**
8818     * This adds an item to the entry's contextual menu.
8819     *
8820     * A longpress on an entry will make the contextual menu show up, if this
8821     * hasn't been disabled with elm_entry_context_menu_disabled_set().
8822     * By default, this menu provides a few options like enabling selection mode,
8823     * which is useful on embedded devices that need to be explicit about it,
8824     * and when a selection exists it also shows the copy and cut actions.
8825     *
8826     * With this function, developers can add other options to this menu to
8827     * perform any action they deem necessary.
8828     *
8829     * @param obj The entry object
8830     * @param label The item's text label
8831     * @param icon_file The item's icon file
8832     * @param icon_type The item's icon type
8833     * @param func The callback to execute when the item is clicked
8834     * @param data The data to associate with the item for related functions
8835     */
8836    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);
8837    /**
8838     * This disables the entry's contextual (longpress) menu.
8839     *
8840     * @param obj The entry object
8841     * @param disabled If true, the menu is disabled
8842     */
8843    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8844    /**
8845     * This returns whether the entry's contextual (longpress) menu is
8846     * disabled.
8847     *
8848     * @param obj The entry object
8849     * @return If true, the menu is disabled
8850     */
8851    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8852    /**
8853     * This appends a custom item provider to the list for that entry
8854     *
8855     * This appends the given callback. The list is walked from beginning to end
8856     * with each function called given the item href string in the text. If the
8857     * function returns an object handle other than NULL (it should create an
8858     * object to do this), then this object is used to replace that item. If
8859     * not the next provider is called until one provides an item object, or the
8860     * default provider in entry does.
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     * @see @ref entry-items
8867     */
8868    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);
8869    /**
8870     * This prepends a custom item provider to the list for that entry
8871     *
8872     * This prepends the given callback. See elm_entry_item_provider_append() for
8873     * more information
8874     *
8875     * @param obj The entry object
8876     * @param func The function called to provide the item object
8877     * @param data The data passed to @p func
8878     */
8879    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);
8880    /**
8881     * This removes a custom item provider to the list for that entry
8882     *
8883     * This removes the given callback. See elm_entry_item_provider_append() for
8884     * more information
8885     *
8886     * @param obj The entry object
8887     * @param func The function called to provide the item object
8888     * @param data The data passed to @p func
8889     */
8890    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);
8891    /**
8892     * Append a filter function for text inserted in the entry
8893     *
8894     * Append the given callback to the list. This functions will be called
8895     * whenever any text is inserted into the entry, with the text to be inserted
8896     * as a parameter. The callback function is free to alter the text in any way
8897     * it wants, but it must remember to free the given pointer and update it.
8898     * If the new text is to be discarded, the function can free it and set its
8899     * text parameter to NULL. This will also prevent any following filters from
8900     * being called.
8901     *
8902     * @param obj The entry object
8903     * @param func The function to use as text filter
8904     * @param data User data to pass to @p func
8905     */
8906    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8907    /**
8908     * Prepend a filter function for text insdrted in the entry
8909     *
8910     * Prepend the given callback to the list. See elm_entry_text_filter_append()
8911     * for more information
8912     *
8913     * @param obj The entry object
8914     * @param func The function to use as text filter
8915     * @param data User data to pass to @p func
8916     */
8917    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8918    /**
8919     * Remove a filter from the list
8920     *
8921     * Removes the given callback from the filter list. See
8922     * elm_entry_text_filter_append() for more information.
8923     *
8924     * @param obj The entry object
8925     * @param func The filter function to remove
8926     * @param data The user data passed when adding the function
8927     */
8928    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
8929    /**
8930     * This converts a markup (HTML-like) string into UTF-8.
8931     *
8932     * The returned string is a malloc'ed buffer and it should be freed when
8933     * not needed anymore.
8934     *
8935     * @param s The string (in markup) to be converted
8936     * @return The converted string (in UTF-8). It should be freed.
8937     */
8938    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8939    /**
8940     * This converts a UTF-8 string into markup (HTML-like).
8941     *
8942     * The returned string is a malloc'ed buffer and it should be freed when
8943     * not needed anymore.
8944     *
8945     * @param s The string (in UTF-8) to be converted
8946     * @return The converted string (in markup). It should be freed.
8947     */
8948    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
8949    /**
8950     * This sets the file (and implicitly loads it) for the text to display and
8951     * then edit. All changes are written back to the file after a short delay if
8952     * the entry object is set to autosave (which is the default).
8953     *
8954     * If the entry had any other file set previously, any changes made to it
8955     * will be saved if the autosave feature is enabled, otherwise, the file
8956     * will be silently discarded and any non-saved changes will be lost.
8957     *
8958     * @param obj The entry object
8959     * @param file The path to the file to load and save
8960     * @param format The file format
8961     */
8962    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8963    /**
8964     * Gets the file being edited by the entry.
8965     *
8966     * This function can be used to retrieve any file set on the entry for
8967     * edition, along with the format used to load and save it.
8968     *
8969     * @param obj The entry object
8970     * @param file The path to the file to load and save
8971     * @param format The file format
8972     */
8973    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8974    /**
8975     * This function writes any changes made to the file set with
8976     * elm_entry_file_set()
8977     *
8978     * @param obj The entry object
8979     */
8980    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8981    /**
8982     * This sets the entry object to 'autosave' the loaded text file or not.
8983     *
8984     * @param obj The entry object
8985     * @param autosave Autosave the loaded file or not
8986     *
8987     * @see elm_entry_file_set()
8988     */
8989    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8990    /**
8991     * This gets the entry object's 'autosave' status.
8992     *
8993     * @param obj The entry object
8994     * @return Autosave the loaded file or not
8995     *
8996     * @see elm_entry_file_set()
8997     */
8998    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8999    /**
9000     * Control pasting of text and images for the widget.
9001     *
9002     * Normally the entry allows both text and images to be pasted.  By setting
9003     * textonly to be true, this prevents images from being pasted.
9004     *
9005     * Note this only changes the behaviour of text.
9006     *
9007     * @param obj The entry object
9008     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9009     * text+image+other.
9010     */
9011    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9012    /**
9013     * Getting elm_entry text paste/drop mode.
9014     *
9015     * In textonly mode, only text may be pasted or dropped into the widget.
9016     *
9017     * @param obj The entry object
9018     * @return If the widget only accepts text from pastes.
9019     */
9020    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9021    /**
9022     * Enable or disable scrolling in entry
9023     *
9024     * Normally the entry is not scrollable unless you enable it with this call.
9025     *
9026     * @param obj The entry object
9027     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9028     */
9029    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9030    /**
9031     * Get the scrollable state of the entry
9032     *
9033     * Normally the entry is not scrollable. This gets the scrollable state
9034     * of the entry. See elm_entry_scrollable_set() for more information.
9035     *
9036     * @param obj The entry object
9037     * @return The scrollable state
9038     */
9039    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
9040    /**
9041     * This sets a widget to be displayed to the left of a scrolled entry.
9042     *
9043     * @param obj The scrolled entry object
9044     * @param icon The widget to display on the left side of the scrolled
9045     * entry.
9046     *
9047     * @note A previously set widget will be destroyed.
9048     * @note If the object being set does not have minimum size hints set,
9049     * it won't get properly displayed.
9050     *
9051     * @see elm_entry_end_set()
9052     */
9053    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9054    /**
9055     * Gets the leftmost widget of the scrolled entry. This object is
9056     * owned by the scrolled entry and should not be modified.
9057     *
9058     * @param obj The scrolled entry object
9059     * @return the left widget inside the scroller
9060     */
9061    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9062    /**
9063     * Unset the leftmost widget of the scrolled entry, unparenting and
9064     * returning it.
9065     *
9066     * @param obj The scrolled entry object
9067     * @return the previously set icon sub-object of this entry, on
9068     * success.
9069     *
9070     * @see elm_entry_icon_set()
9071     */
9072    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9073    /**
9074     * Sets the visibility of the left-side widget of the scrolled entry,
9075     * set by elm_entry_icon_set().
9076     *
9077     * @param obj The scrolled entry object
9078     * @param setting EINA_TRUE if the object should be displayed,
9079     * EINA_FALSE if not.
9080     */
9081    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9082    /**
9083     * This sets a widget to be displayed to the end of a scrolled entry.
9084     *
9085     * @param obj The scrolled entry object
9086     * @param end The widget to display on the right side of the scrolled
9087     * entry.
9088     *
9089     * @note A previously set widget will be destroyed.
9090     * @note If the object being set does not have minimum size hints set,
9091     * it won't get properly displayed.
9092     *
9093     * @see elm_entry_icon_set
9094     */
9095    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9096    /**
9097     * Gets the endmost widget of the scrolled entry. This object is owned
9098     * by the scrolled entry and should not be modified.
9099     *
9100     * @param obj The scrolled entry object
9101     * @return the right widget inside the scroller
9102     */
9103    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9104    /**
9105     * Unset the endmost widget of the scrolled entry, unparenting and
9106     * returning it.
9107     *
9108     * @param obj The scrolled entry object
9109     * @return the previously set icon sub-object of this entry, on
9110     * success.
9111     *
9112     * @see elm_entry_icon_set()
9113     */
9114    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9115    /**
9116     * Sets the visibility of the end widget of the scrolled entry, set by
9117     * elm_entry_end_set().
9118     *
9119     * @param obj The scrolled entry object
9120     * @param setting EINA_TRUE if the object should be displayed,
9121     * EINA_FALSE if not.
9122     */
9123    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9124    /**
9125     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9126     * them).
9127     *
9128     * Setting an entry to single-line mode with elm_entry_single_line_set()
9129     * will automatically disable the display of scrollbars when the entry
9130     * moves inside its scroller.
9131     *
9132     * @param obj The scrolled entry object
9133     * @param h The horizontal scrollbar policy to apply
9134     * @param v The vertical scrollbar policy to apply
9135     */
9136    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9137    /**
9138     * This enables/disables bouncing within the entry.
9139     *
9140     * This function sets whether the entry will bounce when scrolling reaches
9141     * the end of the contained entry.
9142     *
9143     * @param obj The scrolled entry object
9144     * @param h The horizontal bounce state
9145     * @param v The vertical bounce state
9146     */
9147    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9148    /**
9149     * Get the bounce mode
9150     *
9151     * @param obj The Entry object
9152     * @param h_bounce Allow bounce horizontally
9153     * @param v_bounce Allow bounce vertically
9154     */
9155    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9156
9157    /* pre-made filters for entries */
9158    /**
9159     * @typedef Elm_Entry_Filter_Limit_Size
9160     *
9161     * Data for the elm_entry_filter_limit_size() entry filter.
9162     */
9163    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9164    /**
9165     * @struct _Elm_Entry_Filter_Limit_Size
9166     *
9167     * Data for the elm_entry_filter_limit_size() entry filter.
9168     */
9169    struct _Elm_Entry_Filter_Limit_Size
9170      {
9171         int max_char_count; /**< The maximum number of characters allowed. */
9172         int max_byte_count; /**< The maximum number of bytes allowed*/
9173      };
9174    /**
9175     * Filter inserted text based on user defined character and byte limits
9176     *
9177     * Add this filter to an entry to limit the characters that it will accept
9178     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9179     * The funtion works on the UTF-8 representation of the string, converting
9180     * it from the set markup, thus not accounting for any format in it.
9181     *
9182     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9183     * it as data when setting the filter. In it, it's possible to set limits
9184     * by character count or bytes (any of them is disabled if 0), and both can
9185     * be set at the same time. In that case, it first checks for characters,
9186     * then bytes.
9187     *
9188     * The function will cut the inserted text in order to allow only the first
9189     * number of characters that are still allowed. The cut is made in
9190     * characters, even when limiting by bytes, in order to always contain
9191     * valid ones and avoid half unicode characters making it in.
9192     *
9193     * This filter, like any others, does not apply when setting the entry text
9194     * directly with elm_object_text_set() (or the deprecated
9195     * elm_entry_entry_set()).
9196     */
9197    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9198    /**
9199     * @typedef Elm_Entry_Filter_Accept_Set
9200     *
9201     * Data for the elm_entry_filter_accept_set() entry filter.
9202     */
9203    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9204    /**
9205     * @struct _Elm_Entry_Filter_Accept_Set
9206     *
9207     * Data for the elm_entry_filter_accept_set() entry filter.
9208     */
9209    struct _Elm_Entry_Filter_Accept_Set
9210      {
9211         const char *accepted; /**< Set of characters accepted in the entry. */
9212         const char *rejected; /**< Set of characters rejected from the entry. */
9213      };
9214    /**
9215     * Filter inserted text based on accepted or rejected sets of characters
9216     *
9217     * Add this filter to an entry to restrict the set of accepted characters
9218     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9219     * This structure contains both accepted and rejected sets, but they are
9220     * mutually exclusive.
9221     *
9222     * The @c accepted set takes preference, so if it is set, the filter will
9223     * only work based on the accepted characters, ignoring anything in the
9224     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9225     *
9226     * In both cases, the function filters by matching utf8 characters to the
9227     * raw markup text, so it can be used to remove formatting tags.
9228     *
9229     * This filter, like any others, does not apply when setting the entry text
9230     * directly with elm_object_text_set() (or the deprecated
9231     * elm_entry_entry_set()).
9232     */
9233    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9234    /**
9235     * @}
9236     */
9237
9238    /* composite widgets - these basically put together basic widgets above
9239     * in convenient packages that do more than basic stuff */
9240
9241    /* anchorview */
9242    /**
9243     * @defgroup Anchorview Anchorview
9244     *
9245     * @image html img/widget/anchorview/preview-00.png
9246     * @image latex img/widget/anchorview/preview-00.eps
9247     *
9248     * Anchorview is for displaying text that contains markup with anchors
9249     * like <c>\<a href=1234\>something\</\></c> in it.
9250     *
9251     * Besides being styled differently, the anchorview widget provides the
9252     * necessary functionality so that clicking on these anchors brings up a
9253     * popup with user defined content such as "call", "add to contacts" or
9254     * "open web page". This popup is provided using the @ref Hover widget.
9255     *
9256     * This widget is very similar to @ref Anchorblock, so refer to that
9257     * widget for an example. The only difference Anchorview has is that the
9258     * widget is already provided with scrolling functionality, so if the
9259     * text set to it is too large to fit in the given space, it will scroll,
9260     * whereas the @ref Anchorblock widget will keep growing to ensure all the
9261     * text can be displayed.
9262     *
9263     * This widget emits the following signals:
9264     * @li "anchor,clicked": will be called when an anchor is clicked. The
9265     * @p event_info parameter on the callback will be a pointer of type
9266     * ::Elm_Entry_Anchorview_Info.
9267     *
9268     * See @ref Anchorblock for an example on how to use both of them.
9269     *
9270     * @see Anchorblock
9271     * @see Entry
9272     * @see Hover
9273     *
9274     * @{
9275     */
9276    /**
9277     * @typedef Elm_Entry_Anchorview_Info
9278     *
9279     * The info sent in the callback for "anchor,clicked" signals emitted by
9280     * the Anchorview widget.
9281     */
9282    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9283    /**
9284     * @struct _Elm_Entry_Anchorview_Info
9285     *
9286     * The info sent in the callback for "anchor,clicked" signals emitted by
9287     * the Anchorview widget.
9288     */
9289    struct _Elm_Entry_Anchorview_Info
9290      {
9291         const char     *name; /**< Name of the anchor, as indicated in its href
9292                                    attribute */
9293         int             button; /**< The mouse button used to click on it */
9294         Evas_Object    *hover; /**< The hover object to use for the popup */
9295         struct {
9296              Evas_Coord    x, y, w, h;
9297         } anchor, /**< Geometry selection of text used as anchor */
9298           hover_parent; /**< Geometry of the object used as parent by the
9299                              hover */
9300         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
9301                                              for content on the left side of
9302                                              the hover. Before calling the
9303                                              callback, the widget will make the
9304                                              necessary calculations to check
9305                                              which sides are fit to be set with
9306                                              content, based on the position the
9307                                              hover is activated and its distance
9308                                              to the edges of its parent object
9309                                              */
9310         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
9311                                               the right side of the hover.
9312                                               See @ref hover_left */
9313         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
9314                                             of the hover. See @ref hover_left */
9315         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
9316                                                below the hover. See @ref
9317                                                hover_left */
9318      };
9319    /**
9320     * Add a new Anchorview object
9321     *
9322     * @param parent The parent object
9323     * @return The new object or NULL if it cannot be created
9324     */
9325    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9326    /**
9327     * Set the text to show in the anchorview
9328     *
9329     * Sets the text of the anchorview to @p text. This text can include markup
9330     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9331     * text that will be specially styled and react to click events, ended with
9332     * either of \</a\> or \</\>. When clicked, the anchor will emit an
9333     * "anchor,clicked" signal that you can attach a callback to with
9334     * evas_object_smart_callback_add(). The name of the anchor given in the
9335     * event info struct will be the one set in the href attribute, in this
9336     * case, anchorname.
9337     *
9338     * Other markup can be used to style the text in different ways, but it's
9339     * up to the style defined in the theme which tags do what.
9340     * @deprecated use elm_object_text_set() instead.
9341     */
9342    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9343    /**
9344     * Get the markup text set for the anchorview
9345     *
9346     * Retrieves the text set on the anchorview, with markup tags included.
9347     *
9348     * @param obj The anchorview object
9349     * @return The markup text set or @c NULL if nothing was set or an error
9350     * occurred
9351     * @deprecated use elm_object_text_set() instead.
9352     */
9353    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9354    /**
9355     * Set the parent of the hover popup
9356     *
9357     * Sets the parent object to use by the hover created by the anchorview
9358     * when an anchor is clicked. See @ref Hover for more details on this.
9359     * If no parent is set, the same anchorview object will be used.
9360     *
9361     * @param obj The anchorview object
9362     * @param parent The object to use as parent for the hover
9363     */
9364    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9365    /**
9366     * Get the parent of the hover popup
9367     *
9368     * Get the object used as parent for the hover created by the anchorview
9369     * widget. See @ref Hover for more details on this.
9370     *
9371     * @param obj The anchorview object
9372     * @return The object used as parent for the hover, NULL if none is set.
9373     */
9374    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9375    /**
9376     * Set the style that the hover should use
9377     *
9378     * When creating the popup hover, anchorview will request that it's
9379     * themed according to @p style.
9380     *
9381     * @param obj The anchorview object
9382     * @param style The style to use for the underlying hover
9383     *
9384     * @see elm_object_style_set()
9385     */
9386    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9387    /**
9388     * Get the style that the hover should use
9389     *
9390     * Get the style the hover created by anchorview will use.
9391     *
9392     * @param obj The anchorview object
9393     * @return The style to use by the hover. NULL means the default is used.
9394     *
9395     * @see elm_object_style_set()
9396     */
9397    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9398    /**
9399     * Ends the hover popup in the anchorview
9400     *
9401     * When an anchor is clicked, the anchorview widget will create a hover
9402     * object to use as a popup with user provided content. This function
9403     * terminates this popup, returning the anchorview to its normal state.
9404     *
9405     * @param obj The anchorview object
9406     */
9407    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9408    /**
9409     * Set bouncing behaviour when the scrolled content reaches an edge
9410     *
9411     * Tell the internal scroller object whether it should bounce or not
9412     * when it reaches the respective edges for each axis.
9413     *
9414     * @param obj The anchorview object
9415     * @param h_bounce Whether to bounce or not in the horizontal axis
9416     * @param v_bounce Whether to bounce or not in the vertical axis
9417     *
9418     * @see elm_scroller_bounce_set()
9419     */
9420    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9421    /**
9422     * Get the set bouncing behaviour of the internal scroller
9423     *
9424     * Get whether the internal scroller should bounce when the edge of each
9425     * axis is reached scrolling.
9426     *
9427     * @param obj The anchorview object
9428     * @param h_bounce Pointer where to store the bounce state of the horizontal
9429     *                 axis
9430     * @param v_bounce Pointer where to store the bounce state of the vertical
9431     *                 axis
9432     *
9433     * @see elm_scroller_bounce_get()
9434     */
9435    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9436    /**
9437     * Appends a custom item provider to the given anchorview
9438     *
9439     * Appends the given function to the list of items providers. This list is
9440     * called, one function at a time, with the given @p data pointer, the
9441     * anchorview object and, in the @p item parameter, the item name as
9442     * referenced in its href string. Following functions in the list will be
9443     * called in order until one of them returns something different to NULL,
9444     * which should be an Evas_Object which will be used in place of the item
9445     * element.
9446     *
9447     * Items in the markup text take the form \<item relsize=16x16 vsize=full
9448     * href=item/name\>\</item\>
9449     *
9450     * @param obj The anchorview object
9451     * @param func The function to add to the list of providers
9452     * @param data User data that will be passed to the callback function
9453     *
9454     * @see elm_entry_item_provider_append()
9455     */
9456    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);
9457    /**
9458     * Prepend a custom item provider to the given anchorview
9459     *
9460     * Like elm_anchorview_item_provider_append(), but it adds the function
9461     * @p func to the beginning of the list, instead of the end.
9462     *
9463     * @param obj The anchorview object
9464     * @param func The function to add to the list of providers
9465     * @param data User data that will be passed to the callback function
9466     */
9467    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);
9468    /**
9469     * Remove a custom item provider from the list of the given anchorview
9470     *
9471     * Removes the function and data pairing that matches @p func and @p data.
9472     * That is, unless the same function and same user data are given, the
9473     * function will not be removed from the list. This allows us to add the
9474     * same callback several times, with different @p data pointers and be
9475     * able to remove them later without conflicts.
9476     *
9477     * @param obj The anchorview object
9478     * @param func The function to remove from the list
9479     * @param data The data matching the function to remove from the list
9480     */
9481    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);
9482    /**
9483     * @}
9484     */
9485
9486    /* anchorblock */
9487    /**
9488     * @defgroup Anchorblock Anchorblock
9489     *
9490     * @image html img/widget/anchorblock/preview-00.png
9491     * @image latex img/widget/anchorblock/preview-00.eps
9492     *
9493     * Anchorblock is for displaying text that contains markup with anchors
9494     * like <c>\<a href=1234\>something\</\></c> in it.
9495     *
9496     * Besides being styled differently, the anchorblock widget provides the
9497     * necessary functionality so that clicking on these anchors brings up a
9498     * popup with user defined content such as "call", "add to contacts" or
9499     * "open web page". This popup is provided using the @ref Hover widget.
9500     *
9501     * This widget emits the following signals:
9502     * @li "anchor,clicked": will be called when an anchor is clicked. The
9503     * @p event_info parameter on the callback will be a pointer of type
9504     * ::Elm_Entry_Anchorblock_Info.
9505     *
9506     * @see Anchorview
9507     * @see Entry
9508     * @see Hover
9509     *
9510     * Since examples are usually better than plain words, we might as well
9511     * try @ref tutorial_anchorblock_example "one".
9512     */
9513    /**
9514     * @addtogroup Anchorblock
9515     * @{
9516     */
9517    /**
9518     * @typedef Elm_Entry_Anchorblock_Info
9519     *
9520     * The info sent in the callback for "anchor,clicked" signals emitted by
9521     * the Anchorblock widget.
9522     */
9523    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9524    /**
9525     * @struct _Elm_Entry_Anchorblock_Info
9526     *
9527     * The info sent in the callback for "anchor,clicked" signals emitted by
9528     * the Anchorblock widget.
9529     */
9530    struct _Elm_Entry_Anchorblock_Info
9531      {
9532         const char     *name; /**< Name of the anchor, as indicated in its href
9533                                    attribute */
9534         int             button; /**< The mouse button used to click on it */
9535         Evas_Object    *hover; /**< The hover object to use for the popup */
9536         struct {
9537              Evas_Coord    x, y, w, h;
9538         } anchor, /**< Geometry selection of text used as anchor */
9539           hover_parent; /**< Geometry of the object used as parent by the
9540                              hover */
9541         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
9542                                              for content on the left side of
9543                                              the hover. Before calling the
9544                                              callback, the widget will make the
9545                                              necessary calculations to check
9546                                              which sides are fit to be set with
9547                                              content, based on the position the
9548                                              hover is activated and its distance
9549                                              to the edges of its parent object
9550                                              */
9551         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
9552                                               the right side of the hover.
9553                                               See @ref hover_left */
9554         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
9555                                             of the hover. See @ref hover_left */
9556         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
9557                                                below the hover. See @ref
9558                                                hover_left */
9559      };
9560    /**
9561     * Add a new Anchorblock object
9562     *
9563     * @param parent The parent object
9564     * @return The new object or NULL if it cannot be created
9565     */
9566    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9567    /**
9568     * Set the text to show in the anchorblock
9569     *
9570     * Sets the text of the anchorblock to @p text. This text can include markup
9571     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9572     * of text that will be specially styled and react to click events, ended
9573     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9574     * "anchor,clicked" signal that you can attach a callback to with
9575     * evas_object_smart_callback_add(). The name of the anchor given in the
9576     * event info struct will be the one set in the href attribute, in this
9577     * case, anchorname.
9578     *
9579     * Other markup can be used to style the text in different ways, but it's
9580     * up to the style defined in the theme which tags do what.
9581     * @deprecated use elm_object_text_set() instead.
9582     */
9583    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9584    /**
9585     * Get the markup text set for the anchorblock
9586     *
9587     * Retrieves the text set on the anchorblock, with markup tags included.
9588     *
9589     * @param obj The anchorblock object
9590     * @return The markup text set or @c NULL if nothing was set or an error
9591     * occurred
9592     * @deprecated use elm_object_text_set() instead.
9593     */
9594    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9595    /**
9596     * Set the parent of the hover popup
9597     *
9598     * Sets the parent object to use by the hover created by the anchorblock
9599     * when an anchor is clicked. See @ref Hover for more details on this.
9600     *
9601     * @param obj The anchorblock object
9602     * @param parent The object to use as parent for the hover
9603     */
9604    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9605    /**
9606     * Get the parent of the hover popup
9607     *
9608     * Get the object used as parent for the hover created by the anchorblock
9609     * widget. See @ref Hover for more details on this.
9610     * If no parent is set, the same anchorblock object will be used.
9611     *
9612     * @param obj The anchorblock object
9613     * @return The object used as parent for the hover, NULL if none is set.
9614     */
9615    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9616    /**
9617     * Set the style that the hover should use
9618     *
9619     * When creating the popup hover, anchorblock will request that it's
9620     * themed according to @p style.
9621     *
9622     * @param obj The anchorblock object
9623     * @param style The style to use for the underlying hover
9624     *
9625     * @see elm_object_style_set()
9626     */
9627    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9628    /**
9629     * Get the style that the hover should use
9630     *
9631     * Get the style the hover created by anchorblock will use.
9632     *
9633     * @param obj The anchorblock object
9634     * @return The style to use by the hover. NULL means the default is used.
9635     *
9636     * @see elm_object_style_set()
9637     */
9638    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9639    /**
9640     * Ends the hover popup in the anchorblock
9641     *
9642     * When an anchor is clicked, the anchorblock widget will create a hover
9643     * object to use as a popup with user provided content. This function
9644     * terminates this popup, returning the anchorblock to its normal state.
9645     *
9646     * @param obj The anchorblock object
9647     */
9648    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9649    /**
9650     * Appends a custom item provider to the given anchorblock
9651     *
9652     * Appends the given function to the list of items providers. This list is
9653     * called, one function at a time, with the given @p data pointer, the
9654     * anchorblock object and, in the @p item parameter, the item name as
9655     * referenced in its href string. Following functions in the list will be
9656     * called in order until one of them returns something different to NULL,
9657     * which should be an Evas_Object which will be used in place of the item
9658     * element.
9659     *
9660     * Items in the markup text take the form \<item relsize=16x16 vsize=full
9661     * href=item/name\>\</item\>
9662     *
9663     * @param obj The anchorblock object
9664     * @param func The function to add to the list of providers
9665     * @param data User data that will be passed to the callback function
9666     *
9667     * @see elm_entry_item_provider_append()
9668     */
9669    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);
9670    /**
9671     * Prepend a custom item provider to the given anchorblock
9672     *
9673     * Like elm_anchorblock_item_provider_append(), but it adds the function
9674     * @p func to the beginning of the list, instead of the end.
9675     *
9676     * @param obj The anchorblock object
9677     * @param func The function to add to the list of providers
9678     * @param data User data that will be passed to the callback function
9679     */
9680    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);
9681    /**
9682     * Remove a custom item provider from the list of the given anchorblock
9683     *
9684     * Removes the function and data pairing that matches @p func and @p data.
9685     * That is, unless the same function and same user data are given, the
9686     * function will not be removed from the list. This allows us to add the
9687     * same callback several times, with different @p data pointers and be
9688     * able to remove them later without conflicts.
9689     *
9690     * @param obj The anchorblock object
9691     * @param func The function to remove from the list
9692     * @param data The data matching the function to remove from the list
9693     */
9694    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);
9695    /**
9696     * @}
9697     */
9698
9699    /**
9700     * @defgroup Bubble Bubble
9701     *
9702     * @image html img/widget/bubble/preview-00.png
9703     * @image latex img/widget/bubble/preview-00.eps
9704     * @image html img/widget/bubble/preview-01.png
9705     * @image latex img/widget/bubble/preview-01.eps
9706     * @image html img/widget/bubble/preview-02.png
9707     * @image latex img/widget/bubble/preview-02.eps
9708     *
9709     * @brief The Bubble is a widget to show text similarly to how speech is
9710     * represented in comics.
9711     *
9712     * The bubble widget contains 5 important visual elements:
9713     * @li The frame is a rectangle with rounded rectangles and an "arrow".
9714     * @li The @p icon is an image to which the frame's arrow points to.
9715     * @li The @p label is a text which appears to the right of the icon if the
9716     * corner is "top_left" or "bottom_left" and is right aligned to the frame
9717     * otherwise.
9718     * @li The @p info is a text which appears to the right of the label. Info's
9719     * font is of a ligther color than label.
9720     * @li The @p content is an evas object that is shown inside the frame.
9721     *
9722     * The position of the arrow, icon, label and info depends on which corner is
9723     * selected. The four available corners are:
9724     * @li "top_left" - Default
9725     * @li "top_right"
9726     * @li "bottom_left"
9727     * @li "bottom_right"
9728     *
9729     * Signals that you can add callbacks for are:
9730     * @li "clicked" - This is called when a user has clicked the bubble.
9731     *
9732     * For an example of using a buble see @ref bubble_01_example_page "this".
9733     *
9734     * @{
9735     */
9736    /**
9737     * Add a new bubble to the parent
9738     *
9739     * @param parent The parent object
9740     * @return The new object or NULL if it cannot be created
9741     *
9742     * This function adds a text bubble to the given parent evas object.
9743     */
9744    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9745    /**
9746     * Set the label of the bubble
9747     *
9748     * @param obj The bubble object
9749     * @param label The string to set in the label
9750     *
9751     * This function sets the title of the bubble. Where this appears depends on
9752     * the selected corner.
9753     * @deprecated use elm_object_text_set() instead.
9754     */
9755    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9756    /**
9757     * Get the label of the bubble
9758     *
9759     * @param obj The bubble object
9760     * @return The string of set in the label
9761     *
9762     * This function gets the title of the bubble.
9763     * @deprecated use elm_object_text_set() instead.
9764     */
9765    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9766    /**
9767     * Set the info of the bubble
9768     *
9769     * @param obj The bubble object
9770     * @param info The given info about the bubble
9771     *
9772     * This function sets the info of the bubble. Where this appears depends on
9773     * the selected corner.
9774     * @deprecated use elm_object_text_set() instead.
9775     */
9776    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9777    /**
9778     * Get the info of the bubble
9779     *
9780     * @param obj The bubble object
9781     *
9782     * @return The "info" string of the bubble
9783     *
9784     * This function gets the info text.
9785     * @deprecated use elm_object_text_set() instead.
9786     */
9787    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9788    /**
9789     * Set the content to be shown in the bubble
9790     *
9791     * Once the content object is set, a previously set one will be deleted.
9792     * If you want to keep the old content object, use the
9793     * elm_bubble_content_unset() function.
9794     *
9795     * @param obj The bubble object
9796     * @param content The given content of the bubble
9797     *
9798     * This function sets the content shown on the middle of the bubble.
9799     */
9800    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9801    /**
9802     * Get the content shown in the bubble
9803     *
9804     * Return the content object which is set for this widget.
9805     *
9806     * @param obj The bubble object
9807     * @return The content that is being used
9808     */
9809    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9810    /**
9811     * Unset the content shown in the bubble
9812     *
9813     * Unparent and return the content object which was set for this widget.
9814     *
9815     * @param obj The bubble object
9816     * @return The content that was being used
9817     */
9818    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9819    /**
9820     * Set the icon of the bubble
9821     *
9822     * Once the icon object is set, a previously set one will be deleted.
9823     * If you want to keep the old content object, use the
9824     * elm_icon_content_unset() function.
9825     *
9826     * @param obj The bubble object
9827     * @param icon The given icon for the bubble
9828     */
9829    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9830    /**
9831     * Get the icon of the bubble
9832     *
9833     * @param obj The bubble object
9834     * @return The icon for the bubble
9835     *
9836     * This function gets the icon shown on the top left of bubble.
9837     */
9838    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9839    /**
9840     * Unset the icon of the bubble
9841     *
9842     * Unparent and return the icon object which was set for this widget.
9843     *
9844     * @param obj The bubble object
9845     * @return The icon that was being used
9846     */
9847    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9848    /**
9849     * Set the corner of the bubble
9850     *
9851     * @param obj The bubble object.
9852     * @param corner The given corner for the bubble.
9853     *
9854     * This function sets the corner of the bubble. The corner will be used to
9855     * determine where the arrow in the frame points to and where label, icon and
9856     * info arre shown.
9857     *
9858     * Possible values for corner are:
9859     * @li "top_left" - Default
9860     * @li "top_right"
9861     * @li "bottom_left"
9862     * @li "bottom_right"
9863     */
9864    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
9865    /**
9866     * Get the corner of the bubble
9867     *
9868     * @param obj The bubble object.
9869     * @return The given corner for the bubble.
9870     *
9871     * This function gets the selected corner of the bubble.
9872     */
9873    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9874    /**
9875     * @}
9876     */
9877
9878    /* photo */
9879    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9880    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
9881    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
9882    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
9883    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
9884    /* smart callbacks called:
9885     * "clicked" - the user clicked the icon
9886     * "drag,start" - Someone started dragging the image out of the object
9887     * "drag,end" - Dragged item was dropped (somewhere)
9888     */
9889
9890    /* gesture layer */
9891    /**
9892     * @defgroup Elm_Gesture_Layer Gesture Layer
9893     * Gesture Layer Usage:
9894     *
9895     * Use Gesture Layer to detect gestures.
9896     * The advantage is that you don't have to implement
9897     * gesture detection, just set callbacks of gesture state.
9898     * By using gesture layer we make standard interface.
9899     *
9900     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
9901     * with a parent object parameter.
9902     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
9903     * call. Usually with same object as target (2nd parameter).
9904     *
9905     * Now you need to tell gesture layer what gestures you follow.
9906     * This is done with @ref elm_gesture_layer_cb_set call.
9907     * By setting the callback you actually saying to gesture layer:
9908     * I would like to know when the gesture @ref Elm_Gesture_Types
9909     * switches to state @ref Elm_Gesture_State.
9910     *
9911     * Next, you need to implement the actual action that follows the input
9912     * in your callback.
9913     *
9914     * Note that if you like to stop being reported about a gesture, just set
9915     * all callbacks referring this gesture to NULL.
9916     * (again with @ref elm_gesture_layer_cb_set)
9917     *
9918     * The information reported by gesture layer to your callback is depending
9919     * on @ref Elm_Gesture_Types:
9920     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
9921     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
9922     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
9923     *
9924     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
9925     * @ref ELM_GESTURE_MOMENTUM.
9926     *
9927     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
9928     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
9929     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
9930     * Note that we consider a flick as a line-gesture that should be completed
9931     * in flick-time-limit as defined in @ref Config.
9932     *
9933     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
9934     *
9935     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
9936     * */
9937
9938    /**
9939     * @enum _Elm_Gesture_Types
9940     * Enum of supported gesture types.
9941     * @ingroup Elm_Gesture_Layer
9942     */
9943    enum _Elm_Gesture_Types
9944      {
9945         ELM_GESTURE_FIRST = 0,
9946
9947         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
9948         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
9949         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
9950         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
9951
9952         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
9953
9954         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
9955         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
9956
9957         ELM_GESTURE_ZOOM, /**< Zoom */
9958         ELM_GESTURE_ROTATE, /**< Rotate */
9959
9960         ELM_GESTURE_LAST
9961      };
9962
9963    /**
9964     * @typedef Elm_Gesture_Types
9965     * gesture types enum
9966     * @ingroup Elm_Gesture_Layer
9967     */
9968    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
9969
9970    /**
9971     * @enum _Elm_Gesture_State
9972     * Enum of gesture states.
9973     * @ingroup Elm_Gesture_Layer
9974     */
9975    enum _Elm_Gesture_State
9976      {
9977         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
9978         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
9979         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
9980         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
9981         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
9982      };
9983
9984    /**
9985     * @typedef Elm_Gesture_State
9986     * gesture states enum
9987     * @ingroup Elm_Gesture_Layer
9988     */
9989    typedef enum _Elm_Gesture_State Elm_Gesture_State;
9990
9991    /**
9992     * @struct _Elm_Gesture_Taps_Info
9993     * Struct holds taps info for user
9994     * @ingroup Elm_Gesture_Layer
9995     */
9996    struct _Elm_Gesture_Taps_Info
9997      {
9998         Evas_Coord x, y;         /**< Holds center point between fingers */
9999         unsigned int n;          /**< Number of fingers tapped           */
10000         unsigned int timestamp;  /**< event timestamp       */
10001      };
10002
10003    /**
10004     * @typedef Elm_Gesture_Taps_Info
10005     * holds taps info for user
10006     * @ingroup Elm_Gesture_Layer
10007     */
10008    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
10009
10010    /**
10011     * @struct _Elm_Gesture_Momentum_Info
10012     * Struct holds momentum info for user
10013     * x1 and y1 are not necessarily in sync
10014     * x1 holds x value of x direction starting point
10015     * and same holds for y1.
10016     * This is noticeable when doing V-shape movement
10017     * @ingroup Elm_Gesture_Layer
10018     */
10019    struct _Elm_Gesture_Momentum_Info
10020      {  /* Report line ends, timestamps, and momentum computed        */
10021         Evas_Coord x1; /**< Final-swipe direction starting point on X */
10022         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10023         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
10024         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
10025
10026         unsigned int tx; /**< Timestamp of start of final x-swipe */
10027         unsigned int ty; /**< Timestamp of start of final y-swipe */
10028
10029         Evas_Coord mx; /**< Momentum on X */
10030         Evas_Coord my; /**< Momentum on Y */
10031      };
10032
10033    /**
10034     * @typedef Elm_Gesture_Momentum_Info
10035     * holds momentum info for user
10036     * @ingroup Elm_Gesture_Layer
10037     */
10038     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10039
10040    /**
10041     * @struct _Elm_Gesture_Line_Info
10042     * Struct holds line info for user
10043     * @ingroup Elm_Gesture_Layer
10044     */
10045    struct _Elm_Gesture_Line_Info
10046      {  /* Report line ends, timestamps, and momentum computed      */
10047         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10048         unsigned int n;            /**< Number of fingers (lines)   */
10049         /* FIXME should be radians, bot degrees */
10050         double angle;              /**< Angle (direction) of lines  */
10051      };
10052
10053    /**
10054     * @typedef Elm_Gesture_Line_Info
10055     * Holds line info for user
10056     * @ingroup Elm_Gesture_Layer
10057     */
10058     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10059
10060    /**
10061     * @struct _Elm_Gesture_Zoom_Info
10062     * Struct holds zoom info for user
10063     * @ingroup Elm_Gesture_Layer
10064     */
10065    struct _Elm_Gesture_Zoom_Info
10066      {
10067         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
10068         Evas_Coord radius; /**< Holds radius between fingers reported to user */
10069         double zoom;            /**< Zoom value: 1.0 means no zoom             */
10070         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10071      };
10072
10073    /**
10074     * @typedef Elm_Gesture_Zoom_Info
10075     * Holds zoom info for user
10076     * @ingroup Elm_Gesture_Layer
10077     */
10078    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10079
10080    /**
10081     * @struct _Elm_Gesture_Rotate_Info
10082     * Struct holds rotation info for user
10083     * @ingroup Elm_Gesture_Layer
10084     */
10085    struct _Elm_Gesture_Rotate_Info
10086      {
10087         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
10088         Evas_Coord radius; /**< Holds radius between fingers reported to user */
10089         double base_angle; /**< Holds start-angle */
10090         double angle;      /**< Rotation value: 0.0 means no rotation         */
10091         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10092      };
10093
10094    /**
10095     * @typedef Elm_Gesture_Rotate_Info
10096     * Holds rotation info for user
10097     * @ingroup Elm_Gesture_Layer
10098     */
10099    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10100
10101    /**
10102     * @typedef Elm_Gesture_Event_Cb
10103     * User callback used to stream gesture info from gesture layer
10104     * @param data user data
10105     * @param event_info gesture report info
10106     * Returns a flag field to be applied on the causing event.
10107     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10108     * upon the event, in an irreversible way.
10109     *
10110     * @ingroup Elm_Gesture_Layer
10111     */
10112    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10113
10114    /**
10115     * Use function to set callbacks to be notified about
10116     * change of state of gesture.
10117     * When a user registers a callback with this function
10118     * this means this gesture has to be tested.
10119     *
10120     * When ALL callbacks for a gesture are set to NULL
10121     * it means user isn't interested in gesture-state
10122     * and it will not be tested.
10123     *
10124     * @param obj Pointer to gesture-layer.
10125     * @param idx The gesture you would like to track its state.
10126     * @param cb callback function pointer.
10127     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10128     * @param data user info to be sent to callback (usually, Smart Data)
10129     *
10130     * @ingroup Elm_Gesture_Layer
10131     */
10132    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);
10133
10134    /**
10135     * Call this function to get repeat-events settings.
10136     *
10137     * @param obj Pointer to gesture-layer.
10138     *
10139     * @return repeat events settings.
10140     * @see elm_gesture_layer_hold_events_set()
10141     * @ingroup Elm_Gesture_Layer
10142     */
10143    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10144
10145    /**
10146     * This function called in order to make gesture-layer repeat events.
10147     * Set this of you like to get the raw events only if gestures were not detected.
10148     * Clear this if you like gesture layer to fwd events as testing gestures.
10149     *
10150     * @param obj Pointer to gesture-layer.
10151     * @param r Repeat: TRUE/FALSE
10152     *
10153     * @ingroup Elm_Gesture_Layer
10154     */
10155    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10156
10157    /**
10158     * This function sets step-value for zoom action.
10159     * Set step to any positive value.
10160     * Cancel step setting by setting to 0.0
10161     *
10162     * @param obj Pointer to gesture-layer.
10163     * @param s new zoom step value.
10164     *
10165     * @ingroup Elm_Gesture_Layer
10166     */
10167    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10168
10169    /**
10170     * This function sets step-value for rotate action.
10171     * Set step to any positive value.
10172     * Cancel step setting by setting to 0.0
10173     *
10174     * @param obj Pointer to gesture-layer.
10175     * @param s new roatate step value.
10176     *
10177     * @ingroup Elm_Gesture_Layer
10178     */
10179    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10180
10181    /**
10182     * This function called to attach gesture-layer to an Evas_Object.
10183     * @param obj Pointer to gesture-layer.
10184     * @param t Pointer to underlying object (AKA Target)
10185     *
10186     * @return TRUE, FALSE on success, failure.
10187     *
10188     * @ingroup Elm_Gesture_Layer
10189     */
10190    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10191
10192    /**
10193     * Call this function to construct a new gesture-layer object.
10194     * This does not activate the gesture layer. You have to
10195     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10196     *
10197     * @param parent the parent object.
10198     *
10199     * @return Pointer to new gesture-layer object.
10200     *
10201     * @ingroup Elm_Gesture_Layer
10202     */
10203    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10204
10205    /**
10206     * @defgroup Thumb Thumb
10207     *
10208     * @image html img/widget/thumb/preview-00.png
10209     * @image latex img/widget/thumb/preview-00.eps
10210     *
10211     * A thumb object is used for displaying the thumbnail of an image or video.
10212     * You must have compiled Elementary with Ethumb_Client support and the DBus
10213     * service must be present and auto-activated in order to have thumbnails to
10214     * be generated.
10215     *
10216     * Once the thumbnail object becomes visible, it will check if there is a
10217     * previously generated thumbnail image for the file set on it. If not, it
10218     * will start generating this thumbnail.
10219     *
10220     * Different config settings will cause different thumbnails to be generated
10221     * even on the same file.
10222     *
10223     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10224     * Ethumb documentation to change this path, and to see other configuration
10225     * options.
10226     *
10227     * Signals that you can add callbacks for are:
10228     *
10229     * - "clicked" - This is called when a user has clicked the thumb without dragging
10230     *             around.
10231     * - "clicked,double" - This is called when a user has double-clicked the thumb.
10232     * - "press" - This is called when a user has pressed down the thumb.
10233     * - "generate,start" - The thumbnail generation started.
10234     * - "generate,stop" - The generation process stopped.
10235     * - "generate,error" - The generation failed.
10236     * - "load,error" - The thumbnail image loading failed.
10237     *
10238     * available styles:
10239     * - default
10240     * - noframe
10241     *
10242     * An example of use of thumbnail:
10243     *
10244     * - @ref thumb_example_01
10245     */
10246
10247    /**
10248     * @addtogroup Thumb
10249     * @{
10250     */
10251
10252    /**
10253     * @enum _Elm_Thumb_Animation_Setting
10254     * @typedef Elm_Thumb_Animation_Setting
10255     *
10256     * Used to set if a video thumbnail is animating or not.
10257     *
10258     * @ingroup Thumb
10259     */
10260    typedef enum _Elm_Thumb_Animation_Setting
10261      {
10262         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10263         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
10264         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
10265         ELM_THUMB_ANIMATION_LAST
10266      } Elm_Thumb_Animation_Setting;
10267
10268    /**
10269     * Add a new thumb object to the parent.
10270     *
10271     * @param parent The parent object.
10272     * @return The new object or NULL if it cannot be created.
10273     *
10274     * @see elm_thumb_file_set()
10275     * @see elm_thumb_ethumb_client_get()
10276     *
10277     * @ingroup Thumb
10278     */
10279    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10280    /**
10281     * Reload thumbnail if it was generated before.
10282     *
10283     * @param obj The thumb object to reload
10284     *
10285     * This is useful if the ethumb client configuration changed, like its
10286     * size, aspect or any other property one set in the handle returned
10287     * by elm_thumb_ethumb_client_get().
10288     *
10289     * If the options didn't change, the thumbnail won't be generated again, but
10290     * the old one will still be used.
10291     *
10292     * @see elm_thumb_file_set()
10293     *
10294     * @ingroup Thumb
10295     */
10296    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10297    /**
10298     * Set the file that will be used as thumbnail.
10299     *
10300     * @param obj The thumb object.
10301     * @param file The path to file that will be used as thumb.
10302     * @param key The key used in case of an EET file.
10303     *
10304     * The file can be an image or a video (in that case, acceptable extensions are:
10305     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10306     * function elm_thumb_animate().
10307     *
10308     * @see elm_thumb_file_get()
10309     * @see elm_thumb_reload()
10310     * @see elm_thumb_animate()
10311     *
10312     * @ingroup Thumb
10313     */
10314    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10315    /**
10316     * Get the image or video path and key used to generate the thumbnail.
10317     *
10318     * @param obj The thumb object.
10319     * @param file Pointer to filename.
10320     * @param key Pointer to key.
10321     *
10322     * @see elm_thumb_file_set()
10323     * @see elm_thumb_path_get()
10324     *
10325     * @ingroup Thumb
10326     */
10327    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10328    /**
10329     * Get the path and key to the image or video generated by ethumb.
10330     *
10331     * One just need to make sure that the thumbnail was generated before getting
10332     * its path; otherwise, the path will be NULL. One way to do that is by asking
10333     * for the path when/after the "generate,stop" smart callback is called.
10334     *
10335     * @param obj The thumb object.
10336     * @param file Pointer to thumb path.
10337     * @param key Pointer to thumb key.
10338     *
10339     * @see elm_thumb_file_get()
10340     *
10341     * @ingroup Thumb
10342     */
10343    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10344    /**
10345     * Set the animation state for the thumb object. If its content is an animated
10346     * video, you may start/stop the animation or tell it to play continuously and
10347     * looping.
10348     *
10349     * @param obj The thumb object.
10350     * @param setting The animation setting.
10351     *
10352     * @see elm_thumb_file_set()
10353     *
10354     * @ingroup Thumb
10355     */
10356    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10357    /**
10358     * Get the animation state for the thumb object.
10359     *
10360     * @param obj The thumb object.
10361     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10362     * on errors.
10363     *
10364     * @see elm_thumb_animate_set()
10365     *
10366     * @ingroup Thumb
10367     */
10368    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10369    /**
10370     * Get the ethumb_client handle so custom configuration can be made.
10371     *
10372     * @return Ethumb_Client instance or NULL.
10373     *
10374     * This must be called before the objects are created to be sure no object is
10375     * visible and no generation started.
10376     *
10377     * Example of usage:
10378     *
10379     * @code
10380     * #include <Elementary.h>
10381     * #ifndef ELM_LIB_QUICKLAUNCH
10382     * EAPI int
10383     * elm_main(int argc, char **argv)
10384     * {
10385     *    Ethumb_Client *client;
10386     *
10387     *    elm_need_ethumb();
10388     *
10389     *    // ... your code
10390     *
10391     *    client = elm_thumb_ethumb_client_get();
10392     *    if (!client)
10393     *      {
10394     *         ERR("could not get ethumb_client");
10395     *         return 1;
10396     *      }
10397     *    ethumb_client_size_set(client, 100, 100);
10398     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
10399     *    // ... your code
10400     *
10401     *    // Create elm_thumb objects here
10402     *
10403     *    elm_run();
10404     *    elm_shutdown();
10405     *    return 0;
10406     * }
10407     * #endif
10408     * ELM_MAIN()
10409     * @endcode
10410     *
10411     * @note There's only one client handle for Ethumb, so once a configuration
10412     * change is done to it, any other request for thumbnails (for any thumbnail
10413     * object) will use that configuration. Thus, this configuration is global.
10414     *
10415     * @ingroup Thumb
10416     */
10417    EAPI void                        *elm_thumb_ethumb_client_get(void);
10418    /**
10419     * Get the ethumb_client connection state.
10420     *
10421     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10422     * otherwise.
10423     */
10424    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
10425    /**
10426     * Make the thumbnail 'editable'.
10427     *
10428     * @param obj Thumb object.
10429     * @param set Turn on or off editability. Default is @c EINA_FALSE.
10430     *
10431     * This means the thumbnail is a valid drag target for drag and drop, and can be
10432     * cut or pasted too.
10433     *
10434     * @see elm_thumb_editable_get()
10435     *
10436     * @ingroup Thumb
10437     */
10438    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10439    /**
10440     * Make the thumbnail 'editable'.
10441     *
10442     * @param obj Thumb object.
10443     * @return Editability.
10444     *
10445     * This means the thumbnail is a valid drag target for drag and drop, and can be
10446     * cut or pasted too.
10447     *
10448     * @see elm_thumb_editable_set()
10449     *
10450     * @ingroup Thumb
10451     */
10452    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10453
10454    /**
10455     * @}
10456     */
10457
10458    /**
10459     * @defgroup Hoversel Hoversel
10460     *
10461     * @image html img/widget/hoversel/preview-00.png
10462     * @image latex img/widget/hoversel/preview-00.eps
10463     *
10464     * A hoversel is a button that pops up a list of items (automatically
10465     * choosing the direction to display) that have a label and, optionally, an
10466     * icon to select from. It is a convenience widget to avoid the need to do
10467     * all the piecing together yourself. It is intended for a small number of
10468     * items in the hoversel menu (no more than 8), though is capable of many
10469     * more.
10470     *
10471     * Signals that you can add callbacks for are:
10472     * "clicked" - the user clicked the hoversel button and popped up the sel
10473     * "selected" - an item in the hoversel list is selected. event_info is the item
10474     * "dismissed" - the hover is dismissed
10475     *
10476     * See @ref tutorial_hoversel for an example.
10477     * @{
10478     */
10479    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10480    /**
10481     * @brief Add a new Hoversel object
10482     *
10483     * @param parent The parent object
10484     * @return The new object or NULL if it cannot be created
10485     */
10486    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10487    /**
10488     * @brief This sets the hoversel to expand horizontally.
10489     *
10490     * @param obj The hoversel object
10491     * @param horizontal If true, the hover will expand horizontally to the
10492     * right.
10493     *
10494     * @note The initial button will display horizontally regardless of this
10495     * setting.
10496     */
10497    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10498    /**
10499     * @brief This returns whether the hoversel is set to expand horizontally.
10500     *
10501     * @param obj The hoversel object
10502     * @return If true, the hover will expand horizontally to the right.
10503     *
10504     * @see elm_hoversel_horizontal_set()
10505     */
10506    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10507    /**
10508     * @brief Set the Hover parent
10509     *
10510     * @param obj The hoversel object
10511     * @param parent The parent to use
10512     *
10513     * Sets the hover parent object, the area that will be darkened when the
10514     * hoversel is clicked. Should probably be the window that the hoversel is
10515     * in. See @ref Hover objects for more information.
10516     */
10517    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10518    /**
10519     * @brief Get the Hover parent
10520     *
10521     * @param obj The hoversel object
10522     * @return The used parent
10523     *
10524     * Gets the hover parent object.
10525     *
10526     * @see elm_hoversel_hover_parent_set()
10527     */
10528    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10529    /**
10530     * @brief Set the hoversel button label
10531     *
10532     * @param obj The hoversel object
10533     * @param label The label text.
10534     *
10535     * This sets the label of the button that is always visible (before it is
10536     * clicked and expanded).
10537     *
10538     * @deprecated elm_object_text_set()
10539     */
10540    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10541    /**
10542     * @brief Get the hoversel button label
10543     *
10544     * @param obj The hoversel object
10545     * @return The label text.
10546     *
10547     * @deprecated elm_object_text_get()
10548     */
10549    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10550    /**
10551     * @brief Set the icon of the hoversel button
10552     *
10553     * @param obj The hoversel object
10554     * @param icon The icon object
10555     *
10556     * Sets the icon of the button that is always visible (before it is clicked
10557     * and expanded).  Once the icon object is set, a previously set one will be
10558     * deleted, if you want to keep that old content object, use the
10559     * elm_hoversel_icon_unset() function.
10560     *
10561     * @see elm_button_icon_set()
10562     */
10563    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10564    /**
10565     * @brief Get the icon of the hoversel button
10566     *
10567     * @param obj The hoversel object
10568     * @return The icon object
10569     *
10570     * Get the icon of the button that is always visible (before it is clicked
10571     * and expanded). Also see elm_button_icon_get().
10572     *
10573     * @see elm_hoversel_icon_set()
10574     */
10575    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10576    /**
10577     * @brief Get and unparent the icon of the hoversel button
10578     *
10579     * @param obj The hoversel object
10580     * @return The icon object that was being used
10581     *
10582     * Unparent and return the icon of the button that is always visible
10583     * (before it is clicked and expanded).
10584     *
10585     * @see elm_hoversel_icon_set()
10586     * @see elm_button_icon_unset()
10587     */
10588    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10589    /**
10590     * @brief This triggers the hoversel popup from code, the same as if the user
10591     * had clicked the button.
10592     *
10593     * @param obj The hoversel object
10594     */
10595    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10596    /**
10597     * @brief This dismisses the hoversel popup as if the user had clicked
10598     * outside the hover.
10599     *
10600     * @param obj The hoversel object
10601     */
10602    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10603    /**
10604     * @brief Returns whether the hoversel is expanded.
10605     *
10606     * @param obj The hoversel object
10607     * @return  This will return EINA_TRUE if the hoversel is expanded or
10608     * EINA_FALSE if it is not expanded.
10609     */
10610    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10611    /**
10612     * @brief This will remove all the children items from the hoversel.
10613     *
10614     * @param obj The hoversel object
10615     *
10616     * @warning Should @b not be called while the hoversel is active; use
10617     * elm_hoversel_expanded_get() to check first.
10618     *
10619     * @see elm_hoversel_item_del_cb_set()
10620     * @see elm_hoversel_item_del()
10621     */
10622    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10623    /**
10624     * @brief Get the list of items within the given hoversel.
10625     *
10626     * @param obj The hoversel object
10627     * @return Returns a list of Elm_Hoversel_Item*
10628     *
10629     * @see elm_hoversel_item_add()
10630     */
10631    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10632    /**
10633     * @brief Add an item to the hoversel button
10634     *
10635     * @param obj The hoversel object
10636     * @param label The text label to use for the item (NULL if not desired)
10637     * @param icon_file An image file path on disk to use for the icon or standard
10638     * icon name (NULL if not desired)
10639     * @param icon_type The icon type if relevant
10640     * @param func Convenience function to call when this item is selected
10641     * @param data Data to pass to item-related functions
10642     * @return A handle to the item added.
10643     *
10644     * This adds an item to the hoversel to show when it is clicked. Note: if you
10645     * need to use an icon from an edje file then use
10646     * elm_hoversel_item_icon_set() right after the this function, and set
10647     * icon_file to NULL here.
10648     *
10649     * For more information on what @p icon_file and @p icon_type are see the
10650     * @ref Icon "icon documentation".
10651     */
10652    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);
10653    /**
10654     * @brief Delete an item from the hoversel
10655     *
10656     * @param item The item to delete
10657     *
10658     * This deletes the item from the hoversel (should not be called while the
10659     * hoversel is active; use elm_hoversel_expanded_get() to check first).
10660     *
10661     * @see elm_hoversel_item_add()
10662     * @see elm_hoversel_item_del_cb_set()
10663     */
10664    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10665    /**
10666     * @brief Set the function to be called when an item from the hoversel is
10667     * freed.
10668     *
10669     * @param item The item to set the callback on
10670     * @param func The function called
10671     *
10672     * That function will receive these parameters:
10673     * @li void *item_data
10674     * @li Evas_Object *the_item_object
10675     * @li Elm_Hoversel_Item *the_object_struct
10676     *
10677     * @see elm_hoversel_item_add()
10678     */
10679    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10680    /**
10681     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10682     * that will be passed to associated function callbacks.
10683     *
10684     * @param item The item to get the data from
10685     * @return The data pointer set with elm_hoversel_item_add()
10686     *
10687     * @see elm_hoversel_item_add()
10688     */
10689    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10690    /**
10691     * @brief This returns the label text of the given hoversel item.
10692     *
10693     * @param item The item to get the label
10694     * @return The label text of the hoversel item
10695     *
10696     * @see elm_hoversel_item_add()
10697     */
10698    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10699    /**
10700     * @brief This sets the icon for the given hoversel item.
10701     *
10702     * @param item The item to set the icon
10703     * @param icon_file An image file path on disk to use for the icon or standard
10704     * icon name
10705     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10706     * to NULL if the icon is not an edje file
10707     * @param icon_type The icon type
10708     *
10709     * The icon can be loaded from the standard set, from an image file, or from
10710     * an edje file.
10711     *
10712     * @see elm_hoversel_item_add()
10713     */
10714    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);
10715    /**
10716     * @brief Get the icon object of the hoversel item
10717     *
10718     * @param item The item to get the icon from
10719     * @param icon_file The image file path on disk used for the icon or standard
10720     * icon name
10721     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10722     * if the icon is not an edje file
10723     * @param icon_type The icon type
10724     *
10725     * @see elm_hoversel_item_icon_set()
10726     * @see elm_hoversel_item_add()
10727     */
10728    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);
10729    /**
10730     * @}
10731     */
10732
10733    /**
10734     * @defgroup Toolbar Toolbar
10735     * @ingroup Elementary
10736     *
10737     * @image html img/widget/toolbar/preview-00.png
10738     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10739     *
10740     * @image html img/toolbar.png
10741     * @image latex img/toolbar.eps width=\textwidth
10742     *
10743     * A toolbar is a widget that displays a list of items inside
10744     * a box. It can be scrollable, show a menu with items that don't fit
10745     * to toolbar size or even crop them.
10746     *
10747     * Only one item can be selected at a time.
10748     *
10749     * Items can have multiple states, or show menus when selected by the user.
10750     *
10751     * Smart callbacks one can listen to:
10752     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10753     *
10754     * Available styles for it:
10755     * - @c "default"
10756     * - @c "transparent" - no background or shadow, just show the content
10757     *
10758     * List of examples:
10759     * @li @ref toolbar_example_01
10760     * @li @ref toolbar_example_02
10761     * @li @ref toolbar_example_03
10762     */
10763
10764    /**
10765     * @addtogroup Toolbar
10766     * @{
10767     */
10768
10769    /**
10770     * @enum _Elm_Toolbar_Shrink_Mode
10771     * @typedef Elm_Toolbar_Shrink_Mode
10772     *
10773     * Set toolbar's items display behavior, it can be scrollabel,
10774     * show a menu with exceeding items, or simply hide them.
10775     *
10776     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10777     * from elm config.
10778     *
10779     * Values <b> don't </b> work as bitmask, only one can be choosen.
10780     *
10781     * @see elm_toolbar_mode_shrink_set()
10782     * @see elm_toolbar_mode_shrink_get()
10783     *
10784     * @ingroup Toolbar
10785     */
10786    typedef enum _Elm_Toolbar_Shrink_Mode
10787      {
10788         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
10789         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
10790         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10791         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
10792      } Elm_Toolbar_Shrink_Mode;
10793
10794    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(). */
10795
10796    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(). */
10797
10798    /**
10799     * Add a new toolbar widget to the given parent Elementary
10800     * (container) object.
10801     *
10802     * @param parent The parent object.
10803     * @return a new toolbar widget handle or @c NULL, on errors.
10804     *
10805     * This function inserts a new toolbar widget on the canvas.
10806     *
10807     * @ingroup Toolbar
10808     */
10809    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10810
10811    /**
10812     * Set the icon size, in pixels, to be used by toolbar items.
10813     *
10814     * @param obj The toolbar object
10815     * @param icon_size The icon size in pixels
10816     *
10817     * @note Default value is @c 32. It reads value from elm config.
10818     *
10819     * @see elm_toolbar_icon_size_get()
10820     *
10821     * @ingroup Toolbar
10822     */
10823    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
10824
10825    /**
10826     * Get the icon size, in pixels, to be used by toolbar items.
10827     *
10828     * @param obj The toolbar object.
10829     * @return The icon size in pixels.
10830     *
10831     * @see elm_toolbar_icon_size_set() for details.
10832     *
10833     * @ingroup Toolbar
10834     */
10835    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10836
10837    /**
10838     * Sets icon lookup order, for toolbar items' icons.
10839     *
10840     * @param obj The toolbar object.
10841     * @param order The icon lookup order.
10842     *
10843     * Icons added before calling this function will not be affected.
10844     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
10845     *
10846     * @see elm_toolbar_icon_order_lookup_get()
10847     *
10848     * @ingroup Toolbar
10849     */
10850    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
10851
10852    /**
10853     * Gets the icon lookup order.
10854     *
10855     * @param obj The toolbar object.
10856     * @return The icon lookup order.
10857     *
10858     * @see elm_toolbar_icon_order_lookup_set() for details.
10859     *
10860     * @ingroup Toolbar
10861     */
10862    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10863
10864    /**
10865     * Set whether the toolbar items' should be selected by the user or not.
10866     *
10867     * @param obj The toolbar object.
10868     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
10869     * enable it.
10870     *
10871     * This will turn off the ability to select items entirely and they will
10872     * neither appear selected nor emit selected signals. The clicked
10873     * callback function will still be called.
10874     *
10875     * Selection is enabled by default.
10876     *
10877     * @see elm_toolbar_no_select_mode_get().
10878     *
10879     * @ingroup Toolbar
10880     */
10881    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
10882
10883    /**
10884     * Set whether the toolbar items' should be selected by the user or not.
10885     *
10886     * @param obj The toolbar object.
10887     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
10888     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
10889     *
10890     * @see elm_toolbar_no_select_mode_set() for details.
10891     *
10892     * @ingroup Toolbar
10893     */
10894    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10895
10896    /**
10897     * Append item to the toolbar.
10898     *
10899     * @param obj The toolbar object.
10900     * @param icon A string with icon name or the absolute path of an image file.
10901     * @param label The label of the item.
10902     * @param func The function to call when the item is clicked.
10903     * @param data The data to associate with the item for related callbacks.
10904     * @return The created item or @c NULL upon failure.
10905     *
10906     * A new item will be created and appended to the toolbar, i.e., will
10907     * be set as @b last item.
10908     *
10909     * Items created with this method can be deleted with
10910     * elm_toolbar_item_del().
10911     *
10912     * Associated @p data can be properly freed when item is deleted if a
10913     * callback function is set with elm_toolbar_item_del_cb_set().
10914     *
10915     * If a function is passed as argument, it will be called everytime this item
10916     * is selected, i.e., the user clicks over an unselected item.
10917     * If such function isn't needed, just passing
10918     * @c NULL as @p func is enough. The same should be done for @p data.
10919     *
10920     * Toolbar will load icon image from fdo or current theme.
10921     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10922     * If an absolute path is provided it will load it direct from a file.
10923     *
10924     * @see elm_toolbar_item_icon_set()
10925     * @see elm_toolbar_item_del()
10926     * @see elm_toolbar_item_del_cb_set()
10927     *
10928     * @ingroup Toolbar
10929     */
10930    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);
10931
10932    /**
10933     * Prepend item to the toolbar.
10934     *
10935     * @param obj The toolbar object.
10936     * @param icon A string with icon name or the absolute path of an image file.
10937     * @param label The label of the item.
10938     * @param func The function to call when the item is clicked.
10939     * @param data The data to associate with the item for related callbacks.
10940     * @return The created item or @c NULL upon failure.
10941     *
10942     * A new item will be created and prepended to the toolbar, i.e., will
10943     * be set as @b first item.
10944     *
10945     * Items created with this method can be deleted with
10946     * elm_toolbar_item_del().
10947     *
10948     * Associated @p data can be properly freed when item is deleted if a
10949     * callback function is set with elm_toolbar_item_del_cb_set().
10950     *
10951     * If a function is passed as argument, it will be called everytime this item
10952     * is selected, i.e., the user clicks over an unselected item.
10953     * If such function isn't needed, just passing
10954     * @c NULL as @p func is enough. The same should be done for @p data.
10955     *
10956     * Toolbar will load icon image from fdo or current theme.
10957     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10958     * If an absolute path is provided it will load it direct from a file.
10959     *
10960     * @see elm_toolbar_item_icon_set()
10961     * @see elm_toolbar_item_del()
10962     * @see elm_toolbar_item_del_cb_set()
10963     *
10964     * @ingroup Toolbar
10965     */
10966    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);
10967
10968    /**
10969     * Insert a new item into the toolbar object before item @p before.
10970     *
10971     * @param obj The toolbar object.
10972     * @param before The toolbar item to insert before.
10973     * @param icon A string with icon name or the absolute path of an image file.
10974     * @param label The label of the item.
10975     * @param func The function to call when the item is clicked.
10976     * @param data The data to associate with the item for related callbacks.
10977     * @return The created item or @c NULL upon failure.
10978     *
10979     * A new item will be created and added to the toolbar. Its position in
10980     * this toolbar will be just before item @p before.
10981     *
10982     * Items created with this method can be deleted with
10983     * elm_toolbar_item_del().
10984     *
10985     * Associated @p data can be properly freed when item is deleted if a
10986     * callback function is set with elm_toolbar_item_del_cb_set().
10987     *
10988     * If a function is passed as argument, it will be called everytime this item
10989     * is selected, i.e., the user clicks over an unselected item.
10990     * If such function isn't needed, just passing
10991     * @c NULL as @p func is enough. The same should be done for @p data.
10992     *
10993     * Toolbar will load icon image from fdo or current theme.
10994     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
10995     * If an absolute path is provided it will load it direct from a file.
10996     *
10997     * @see elm_toolbar_item_icon_set()
10998     * @see elm_toolbar_item_del()
10999     * @see elm_toolbar_item_del_cb_set()
11000     *
11001     * @ingroup Toolbar
11002     */
11003    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);
11004
11005    /**
11006     * Insert a new item into the toolbar object after item @p after.
11007     *
11008     * @param obj The toolbar object.
11009     * @param before The toolbar item to insert before.
11010     * @param icon A string with icon name or the absolute path of an image file.
11011     * @param label The label of the item.
11012     * @param func The function to call when the item is clicked.
11013     * @param data The data to associate with the item for related callbacks.
11014     * @return The created item or @c NULL upon failure.
11015     *
11016     * A new item will be created and added to the toolbar. Its position in
11017     * this toolbar will be just after item @p after.
11018     *
11019     * Items created with this method can be deleted with
11020     * elm_toolbar_item_del().
11021     *
11022     * Associated @p data can be properly freed when item is deleted if a
11023     * callback function is set with elm_toolbar_item_del_cb_set().
11024     *
11025     * If a function is passed as argument, it will be called everytime this item
11026     * is selected, i.e., the user clicks over an unselected item.
11027     * If such function isn't needed, just passing
11028     * @c NULL as @p func is enough. The same should be done for @p data.
11029     *
11030     * Toolbar will load icon image from fdo or current theme.
11031     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11032     * If an absolute path is provided it will load it direct from a file.
11033     *
11034     * @see elm_toolbar_item_icon_set()
11035     * @see elm_toolbar_item_del()
11036     * @see elm_toolbar_item_del_cb_set()
11037     *
11038     * @ingroup Toolbar
11039     */
11040    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);
11041
11042    /**
11043     * Get the first item in the given toolbar widget's list of
11044     * items.
11045     *
11046     * @param obj The toolbar object
11047     * @return The first item or @c NULL, if it has no items (and on
11048     * errors)
11049     *
11050     * @see elm_toolbar_item_append()
11051     * @see elm_toolbar_last_item_get()
11052     *
11053     * @ingroup Toolbar
11054     */
11055    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11056
11057    /**
11058     * Get the last item in the given toolbar widget's list of
11059     * items.
11060     *
11061     * @param obj The toolbar object
11062     * @return The last item or @c NULL, if it has no items (and on
11063     * errors)
11064     *
11065     * @see elm_toolbar_item_prepend()
11066     * @see elm_toolbar_first_item_get()
11067     *
11068     * @ingroup Toolbar
11069     */
11070    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11071
11072    /**
11073     * Get the item after @p item in toolbar.
11074     *
11075     * @param item The toolbar item.
11076     * @return The item after @p item, or @c NULL if none or on failure.
11077     *
11078     * @note If it is the last item, @c NULL will be returned.
11079     *
11080     * @see elm_toolbar_item_append()
11081     *
11082     * @ingroup Toolbar
11083     */
11084    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11085
11086    /**
11087     * Get the item before @p item in toolbar.
11088     *
11089     * @param item The toolbar item.
11090     * @return The item before @p item, or @c NULL if none or on failure.
11091     *
11092     * @note If it is the first item, @c NULL will be returned.
11093     *
11094     * @see elm_toolbar_item_prepend()
11095     *
11096     * @ingroup Toolbar
11097     */
11098    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11099
11100    /**
11101     * Get the toolbar object from an item.
11102     *
11103     * @param item The item.
11104     * @return The toolbar object.
11105     *
11106     * This returns the toolbar object itself that an item belongs to.
11107     *
11108     * @ingroup Toolbar
11109     */
11110    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11111
11112    /**
11113     * Set the priority of a toolbar item.
11114     *
11115     * @param item The toolbar item.
11116     * @param priority The item priority. The default is zero.
11117     *
11118     * This is used only when the toolbar shrink mode is set to
11119     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11120     * When space is less than required, items with low priority
11121     * will be removed from the toolbar and added to a dynamically-created menu,
11122     * while items with higher priority will remain on the toolbar,
11123     * with the same order they were added.
11124     *
11125     * @see elm_toolbar_item_priority_get()
11126     *
11127     * @ingroup Toolbar
11128     */
11129    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11130
11131    /**
11132     * Get the priority of a toolbar item.
11133     *
11134     * @param item The toolbar item.
11135     * @return The @p item priority, or @c 0 on failure.
11136     *
11137     * @see elm_toolbar_item_priority_set() for details.
11138     *
11139     * @ingroup Toolbar
11140     */
11141    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11142
11143    /**
11144     * Get the label of item.
11145     *
11146     * @param item The item of toolbar.
11147     * @return The label of item.
11148     *
11149     * The return value is a pointer to the label associated to @p item when
11150     * it was created, with function elm_toolbar_item_append() or similar,
11151     * or later,
11152     * with function elm_toolbar_item_label_set. If no label
11153     * was passed as argument, it will return @c NULL.
11154     *
11155     * @see elm_toolbar_item_label_set() for more details.
11156     * @see elm_toolbar_item_append()
11157     *
11158     * @ingroup Toolbar
11159     */
11160    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11161
11162    /**
11163     * Set the label of item.
11164     *
11165     * @param item The item of toolbar.
11166     * @param text The label of item.
11167     *
11168     * The label to be displayed by the item.
11169     * Label will be placed at icons bottom (if set).
11170     *
11171     * If a label was passed as argument on item creation, with function
11172     * elm_toolbar_item_append() or similar, it will be already
11173     * displayed by the item.
11174     *
11175     * @see elm_toolbar_item_label_get()
11176     * @see elm_toolbar_item_append()
11177     *
11178     * @ingroup Toolbar
11179     */
11180    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11181
11182    /**
11183     * Return the data associated with a given toolbar widget item.
11184     *
11185     * @param item The toolbar widget item handle.
11186     * @return The data associated with @p item.
11187     *
11188     * @see elm_toolbar_item_data_set()
11189     *
11190     * @ingroup Toolbar
11191     */
11192    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11193
11194    /**
11195     * Set the data associated with a given toolbar widget item.
11196     *
11197     * @param item The toolbar widget item handle.
11198     * @param data The new data pointer to set to @p item.
11199     *
11200     * This sets new item data on @p item.
11201     *
11202     * @warning The old data pointer won't be touched by this function, so
11203     * the user had better to free that old data himself/herself.
11204     *
11205     * @ingroup Toolbar
11206     */
11207    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11208
11209    /**
11210     * Returns a pointer to a toolbar item by its label.
11211     *
11212     * @param obj The toolbar object.
11213     * @param label The label of the item to find.
11214     *
11215     * @return The pointer to the toolbar item matching @p label or @c NULL
11216     * on failure.
11217     *
11218     * @ingroup Toolbar
11219     */
11220    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11221
11222    /*
11223     * Get whether the @p item is selected or not.
11224     *
11225     * @param item The toolbar item.
11226     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11227     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11228     *
11229     * @see elm_toolbar_selected_item_set() for details.
11230     * @see elm_toolbar_item_selected_get()
11231     *
11232     * @ingroup Toolbar
11233     */
11234    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11235
11236    /**
11237     * Set the selected state of an item.
11238     *
11239     * @param item The toolbar item
11240     * @param selected The selected state
11241     *
11242     * This sets the selected state of the given item @p it.
11243     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11244     *
11245     * If a new item is selected the previosly selected will be unselected.
11246     * Previoulsy selected item can be get with function
11247     * elm_toolbar_selected_item_get().
11248     *
11249     * Selected items will be highlighted.
11250     *
11251     * @see elm_toolbar_item_selected_get()
11252     * @see elm_toolbar_selected_item_get()
11253     *
11254     * @ingroup Toolbar
11255     */
11256    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11257
11258    /**
11259     * Get the selected item.
11260     *
11261     * @param obj The toolbar object.
11262     * @return The selected toolbar item.
11263     *
11264     * The selected item can be unselected with function
11265     * elm_toolbar_item_selected_set().
11266     *
11267     * The selected item always will be highlighted on toolbar.
11268     *
11269     * @see elm_toolbar_selected_items_get()
11270     *
11271     * @ingroup Toolbar
11272     */
11273    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11274
11275    /**
11276     * Set the icon associated with @p item.
11277     *
11278     * @param obj The parent of this item.
11279     * @param item The toolbar item.
11280     * @param icon A string with icon name or the absolute path of an image file.
11281     *
11282     * Toolbar will load icon image from fdo or current theme.
11283     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11284     * If an absolute path is provided it will load it direct from a file.
11285     *
11286     * @see elm_toolbar_icon_order_lookup_set()
11287     * @see elm_toolbar_icon_order_lookup_get()
11288     *
11289     * @ingroup Toolbar
11290     */
11291    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11292
11293    /**
11294     * Get the string used to set the icon of @p item.
11295     *
11296     * @param item The toolbar item.
11297     * @return The string associated with the icon object.
11298     *
11299     * @see elm_toolbar_item_icon_set() for details.
11300     *
11301     * @ingroup Toolbar
11302     */
11303    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11304
11305    /**
11306     * Delete them item from the toolbar.
11307     *
11308     * @param item The item of toolbar to be deleted.
11309     *
11310     * @see elm_toolbar_item_append()
11311     * @see elm_toolbar_item_del_cb_set()
11312     *
11313     * @ingroup Toolbar
11314     */
11315    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11316
11317    /**
11318     * Set the function called when a toolbar item is freed.
11319     *
11320     * @param item The item to set the callback on.
11321     * @param func The function called.
11322     *
11323     * If there is a @p func, then it will be called prior item's memory release.
11324     * That will be called with the following arguments:
11325     * @li item's data;
11326     * @li item's Evas object;
11327     * @li item itself;
11328     *
11329     * This way, a data associated to a toolbar item could be properly freed.
11330     *
11331     * @ingroup Toolbar
11332     */
11333    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11334
11335    /**
11336     * Get a value whether toolbar item is disabled or not.
11337     *
11338     * @param item The item.
11339     * @return The disabled state.
11340     *
11341     * @see elm_toolbar_item_disabled_set() for more details.
11342     *
11343     * @ingroup Toolbar
11344     */
11345    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11346
11347    /**
11348     * Sets the disabled/enabled state of a toolbar item.
11349     *
11350     * @param item The item.
11351     * @param disabled The disabled state.
11352     *
11353     * A disabled item cannot be selected or unselected. It will also
11354     * change its appearance (generally greyed out). This sets the
11355     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11356     * enabled).
11357     *
11358     * @ingroup Toolbar
11359     */
11360    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11361
11362    /**
11363     * Set or unset item as a separator.
11364     *
11365     * @param item The toolbar item.
11366     * @param setting @c EINA_TRUE to set item @p item as separator or
11367     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11368     *
11369     * Items aren't set as separator by default.
11370     *
11371     * If set as separator it will display separator theme, so won't display
11372     * icons or label.
11373     *
11374     * @see elm_toolbar_item_separator_get()
11375     *
11376     * @ingroup Toolbar
11377     */
11378    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11379
11380    /**
11381     * Get a value whether item is a separator or not.
11382     *
11383     * @param item The toolbar item.
11384     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11385     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11386     *
11387     * @see elm_toolbar_item_separator_set() for details.
11388     *
11389     * @ingroup Toolbar
11390     */
11391    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11392
11393    /**
11394     * Set the shrink state of toolbar @p obj.
11395     *
11396     * @param obj The toolbar object.
11397     * @param shrink_mode Toolbar's items display behavior.
11398     *
11399     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11400     * but will enforce a minimun size so all the items will fit, won't scroll
11401     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11402     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11403     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11404     *
11405     * @ingroup Toolbar
11406     */
11407    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11408
11409    /**
11410     * Get the shrink mode of toolbar @p obj.
11411     *
11412     * @param obj The toolbar object.
11413     * @return Toolbar's items display behavior.
11414     *
11415     * @see elm_toolbar_mode_shrink_set() for details.
11416     *
11417     * @ingroup Toolbar
11418     */
11419    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_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     * @ingroup Toolbar
11432     */
11433    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11434
11435    /**
11436     * Get whether the homogenous mode is enabled.
11437     *
11438     * @param obj The toolbar object.
11439     * @return Assume the items within the toolbar are of the same height
11440     * and width (EINA_TRUE = on, EINA_FALSE = off).
11441     *
11442     * @see elm_toolbar_homogeneous_set()
11443     *
11444     * @ingroup Toolbar
11445     */
11446    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11447
11448    /**
11449     * Enable/disable homogenous mode.
11450     *
11451     * @param obj The toolbar object
11452     * @param homogeneous Assume the items within the toolbar are of the
11453     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11454     *
11455     * This will enable the homogeneous mode where items are of the same size.
11456     * @see elm_toolbar_homogeneous_get()
11457     *
11458     * @deprecated use elm_toolbar_homogeneous_set() instead.
11459     *
11460     * @ingroup Toolbar
11461     */
11462    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11463
11464    /**
11465     * Get whether the homogenous mode is enabled.
11466     *
11467     * @param obj The toolbar object.
11468     * @return Assume the items within the toolbar are of the same height
11469     * and width (EINA_TRUE = on, EINA_FALSE = off).
11470     *
11471     * @see elm_toolbar_homogeneous_set()
11472     * @deprecated use elm_toolbar_homogeneous_get() instead.
11473     *
11474     * @ingroup Toolbar
11475     */
11476    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11477
11478    /**
11479     * Set the parent object of the toolbar items' menus.
11480     *
11481     * @param obj The toolbar object.
11482     * @param parent The parent of the menu objects.
11483     *
11484     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11485     *
11486     * For more details about setting the parent for toolbar menus, see
11487     * elm_menu_parent_set().
11488     *
11489     * @see elm_menu_parent_set() for details.
11490     * @see elm_toolbar_item_menu_set() for details.
11491     *
11492     * @ingroup Toolbar
11493     */
11494    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11495
11496    /**
11497     * Get the parent object of the toolbar items' menus.
11498     *
11499     * @param obj The toolbar object.
11500     * @return The parent of the menu objects.
11501     *
11502     * @see elm_toolbar_menu_parent_set() for details.
11503     *
11504     * @ingroup Toolbar
11505     */
11506    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11507
11508    /**
11509     * Set the alignment of the items.
11510     *
11511     * @param obj The toolbar object.
11512     * @param align The new alignment, a float between <tt> 0.0 </tt>
11513     * and <tt> 1.0 </tt>.
11514     *
11515     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11516     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11517     * items.
11518     *
11519     * Centered items by default.
11520     *
11521     * @see elm_toolbar_align_get()
11522     *
11523     * @ingroup Toolbar
11524     */
11525    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11526
11527    /**
11528     * Get the alignment of the items.
11529     *
11530     * @param obj The toolbar object.
11531     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11532     * <tt> 1.0 </tt>.
11533     *
11534     * @see elm_toolbar_align_set() for details.
11535     *
11536     * @ingroup Toolbar
11537     */
11538    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11539
11540    /**
11541     * Set whether the toolbar item opens a menu.
11542     *
11543     * @param item The toolbar item.
11544     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11545     *
11546     * A toolbar item can be set to be a menu, using this function.
11547     *
11548     * Once it is set to be a menu, it can be manipulated through the
11549     * menu-like function elm_toolbar_menu_parent_set() and the other
11550     * elm_menu functions, using the Evas_Object @c menu returned by
11551     * elm_toolbar_item_menu_get().
11552     *
11553     * So, items to be displayed in this item's menu should be added with
11554     * elm_menu_item_add().
11555     *
11556     * The following code exemplifies the most basic usage:
11557     * @code
11558     * tb = elm_toolbar_add(win)
11559     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11560     * elm_toolbar_item_menu_set(item, EINA_TRUE);
11561     * elm_toolbar_menu_parent_set(tb, win);
11562     * menu = elm_toolbar_item_menu_get(item);
11563     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11564     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11565     * NULL);
11566     * @endcode
11567     *
11568     * @see elm_toolbar_item_menu_get()
11569     *
11570     * @ingroup Toolbar
11571     */
11572    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11573
11574    /**
11575     * Get toolbar item's menu.
11576     *
11577     * @param item The toolbar item.
11578     * @return Item's menu object or @c NULL on failure.
11579     *
11580     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11581     * this function will set it.
11582     *
11583     * @see elm_toolbar_item_menu_set() for details.
11584     *
11585     * @ingroup Toolbar
11586     */
11587    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11588
11589    /**
11590     * Add a new state to @p item.
11591     *
11592     * @param item The item.
11593     * @param icon A string with icon name or the absolute path of an image file.
11594     * @param label The label of the new state.
11595     * @param func The function to call when the item is clicked when this
11596     * state is selected.
11597     * @param data The data to associate with the state.
11598     * @return The toolbar item state, or @c NULL upon failure.
11599     *
11600     * Toolbar will load icon image from fdo or current theme.
11601     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11602     * If an absolute path is provided it will load it direct from a file.
11603     *
11604     * States created with this function can be removed with
11605     * elm_toolbar_item_state_del().
11606     *
11607     * @see elm_toolbar_item_state_del()
11608     * @see elm_toolbar_item_state_sel()
11609     * @see elm_toolbar_item_state_get()
11610     *
11611     * @ingroup Toolbar
11612     */
11613    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);
11614
11615    /**
11616     * Delete a previoulsy added state to @p item.
11617     *
11618     * @param item The toolbar item.
11619     * @param state The state to be deleted.
11620     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11621     *
11622     * @see elm_toolbar_item_state_add()
11623     */
11624    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11625
11626    /**
11627     * Set @p state as the current state of @p it.
11628     *
11629     * @param it The item.
11630     * @param state The state to use.
11631     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11632     *
11633     * If @p state is @c NULL, it won't select any state and the default item's
11634     * icon and label will be used. It's the same behaviour than
11635     * elm_toolbar_item_state_unser().
11636     *
11637     * @see elm_toolbar_item_state_unset()
11638     *
11639     * @ingroup Toolbar
11640     */
11641    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11642
11643    /**
11644     * Unset the state of @p it.
11645     *
11646     * @param it The item.
11647     *
11648     * The default icon and label from this item will be displayed.
11649     *
11650     * @see elm_toolbar_item_state_set() for more details.
11651     *
11652     * @ingroup Toolbar
11653     */
11654    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11655
11656    /**
11657     * Get the current state of @p it.
11658     *
11659     * @param item The item.
11660     * @return The selected state or @c NULL if none is selected or on failure.
11661     *
11662     * @see elm_toolbar_item_state_set() for details.
11663     * @see elm_toolbar_item_state_unset()
11664     * @see elm_toolbar_item_state_add()
11665     *
11666     * @ingroup Toolbar
11667     */
11668    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11669
11670    /**
11671     * Get the state after selected state in toolbar's @p item.
11672     *
11673     * @param it The toolbar item to change state.
11674     * @return The state after current state, or @c NULL on failure.
11675     *
11676     * If last state is selected, this function will return first state.
11677     *
11678     * @see elm_toolbar_item_state_set()
11679     * @see elm_toolbar_item_state_add()
11680     *
11681     * @ingroup Toolbar
11682     */
11683    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11684
11685    /**
11686     * Get the state before selected state in toolbar's @p item.
11687     *
11688     * @param it The toolbar item to change state.
11689     * @return The state before current state, or @c NULL on failure.
11690     *
11691     * If first state is selected, this function will return last state.
11692     *
11693     * @see elm_toolbar_item_state_set()
11694     * @see elm_toolbar_item_state_add()
11695     *
11696     * @ingroup Toolbar
11697     */
11698    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11699
11700    /**
11701     * Set the text to be shown in a given toolbar item's tooltips.
11702     *
11703     * @param item Target item.
11704     * @param text The text to set in the content.
11705     *
11706     * Setup the text as tooltip to object. The item can have only one tooltip,
11707     * so any previous tooltip data - set with this function or
11708     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11709     *
11710     * @see elm_object_tooltip_text_set() for more details.
11711     *
11712     * @ingroup Toolbar
11713     */
11714    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11715
11716    /**
11717     * Set the content to be shown in the tooltip item.
11718     *
11719     * Setup the tooltip to item. The item can have only one tooltip,
11720     * so any previous tooltip data is removed. @p func(with @p data) will
11721     * be called every time that need show the tooltip and it should
11722     * return a valid Evas_Object. This object is then managed fully by
11723     * tooltip system and is deleted when the tooltip is gone.
11724     *
11725     * @param item the toolbar item being attached a tooltip.
11726     * @param func the function used to create the tooltip contents.
11727     * @param data what to provide to @a func as callback data/context.
11728     * @param del_cb called when data is not needed anymore, either when
11729     *        another callback replaces @a func, the tooltip is unset with
11730     *        elm_toolbar_item_tooltip_unset() or the owner @a item
11731     *        dies. This callback receives as the first parameter the
11732     *        given @a data, and @c event_info is the item.
11733     *
11734     * @see elm_object_tooltip_content_cb_set() for more details.
11735     *
11736     * @ingroup Toolbar
11737     */
11738    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);
11739
11740    /**
11741     * Unset tooltip from item.
11742     *
11743     * @param item toolbar item to remove previously set tooltip.
11744     *
11745     * Remove tooltip from item. The callback provided as del_cb to
11746     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11747     * it is not used anymore.
11748     *
11749     * @see elm_object_tooltip_unset() for more details.
11750     * @see elm_toolbar_item_tooltip_content_cb_set()
11751     *
11752     * @ingroup Toolbar
11753     */
11754    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11755
11756    /**
11757     * Sets a different style for this item tooltip.
11758     *
11759     * @note before you set a style you should define a tooltip with
11760     *       elm_toolbar_item_tooltip_content_cb_set() or
11761     *       elm_toolbar_item_tooltip_text_set()
11762     *
11763     * @param item toolbar item with tooltip already set.
11764     * @param style the theme style to use (default, transparent, ...)
11765     *
11766     * @see elm_object_tooltip_style_set() for more details.
11767     *
11768     * @ingroup Toolbar
11769     */
11770    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11771
11772    /**
11773     * Get the style for this item tooltip.
11774     *
11775     * @param item toolbar item with tooltip already set.
11776     * @return style the theme style in use, defaults to "default". If the
11777     *         object does not have a tooltip set, then NULL is returned.
11778     *
11779     * @see elm_object_tooltip_style_get() for more details.
11780     * @see elm_toolbar_item_tooltip_style_set()
11781     *
11782     * @ingroup Toolbar
11783     */
11784    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11785
11786    /**
11787     * Set the type of mouse pointer/cursor decoration to be shown,
11788     * when the mouse pointer is over the given toolbar widget item
11789     *
11790     * @param item toolbar item to customize cursor on
11791     * @param cursor the cursor type's name
11792     *
11793     * This function works analogously as elm_object_cursor_set(), but
11794     * here the cursor's changing area is restricted to the item's
11795     * area, and not the whole widget's. Note that that item cursors
11796     * have precedence over widget cursors, so that a mouse over an
11797     * item with custom cursor set will always show @b that cursor.
11798     *
11799     * If this function is called twice for an object, a previously set
11800     * cursor will be unset on the second call.
11801     *
11802     * @see elm_object_cursor_set()
11803     * @see elm_toolbar_item_cursor_get()
11804     * @see elm_toolbar_item_cursor_unset()
11805     *
11806     * @ingroup Toolbar
11807     */
11808    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
11809
11810    /*
11811     * Get the type of mouse pointer/cursor decoration set to be shown,
11812     * when the mouse pointer is over the given toolbar widget item
11813     *
11814     * @param item toolbar item with custom cursor set
11815     * @return the cursor type's name or @c NULL, if no custom cursors
11816     * were set to @p item (and on errors)
11817     *
11818     * @see elm_object_cursor_get()
11819     * @see elm_toolbar_item_cursor_set()
11820     * @see elm_toolbar_item_cursor_unset()
11821     *
11822     * @ingroup Toolbar
11823     */
11824    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11825
11826    /**
11827     * Unset any custom mouse pointer/cursor decoration set to be
11828     * shown, when the mouse pointer is over the given toolbar widget
11829     * item, thus making it show the @b default cursor again.
11830     *
11831     * @param item a toolbar item
11832     *
11833     * Use this call to undo any custom settings on this item's cursor
11834     * decoration, bringing it back to defaults (no custom style set).
11835     *
11836     * @see elm_object_cursor_unset()
11837     * @see elm_toolbar_item_cursor_set()
11838     *
11839     * @ingroup Toolbar
11840     */
11841    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11842
11843    /**
11844     * Set a different @b style for a given custom cursor set for a
11845     * toolbar item.
11846     *
11847     * @param item toolbar item with custom cursor set
11848     * @param style the <b>theme style</b> to use (e.g. @c "default",
11849     * @c "transparent", etc)
11850     *
11851     * This function only makes sense when one is using custom mouse
11852     * cursor decorations <b>defined in a theme file</b>, which can have,
11853     * given a cursor name/type, <b>alternate styles</b> on it. It
11854     * works analogously as elm_object_cursor_style_set(), but here
11855     * applyed only to toolbar item objects.
11856     *
11857     * @warning Before you set a cursor style you should have definen a
11858     *       custom cursor previously on the item, with
11859     *       elm_toolbar_item_cursor_set()
11860     *
11861     * @see elm_toolbar_item_cursor_engine_only_set()
11862     * @see elm_toolbar_item_cursor_style_get()
11863     *
11864     * @ingroup Toolbar
11865     */
11866    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11867
11868    /**
11869     * Get the current @b style set for a given toolbar item's custom
11870     * cursor
11871     *
11872     * @param item toolbar item with custom cursor set.
11873     * @return style the cursor style in use. If the object does not
11874     *         have a cursor set, then @c NULL is returned.
11875     *
11876     * @see elm_toolbar_item_cursor_style_set() for more details
11877     *
11878     * @ingroup Toolbar
11879     */
11880    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11881
11882    /**
11883     * Set if the (custom)cursor for a given toolbar item should be
11884     * searched in its theme, also, or should only rely on the
11885     * rendering engine.
11886     *
11887     * @param item item with custom (custom) cursor already set on
11888     * @param engine_only Use @c EINA_TRUE to have cursors looked for
11889     * only on those provided by the rendering engine, @c EINA_FALSE to
11890     * have them searched on the widget's theme, as well.
11891     *
11892     * @note This call is of use only if you've set a custom cursor
11893     * for toolbar items, with elm_toolbar_item_cursor_set().
11894     *
11895     * @note By default, cursors will only be looked for between those
11896     * provided by the rendering engine.
11897     *
11898     * @ingroup Toolbar
11899     */
11900    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11901
11902    /**
11903     * Get if the (custom) cursor for a given toolbar item is being
11904     * searched in its theme, also, or is only relying on the rendering
11905     * engine.
11906     *
11907     * @param item a toolbar item
11908     * @return @c EINA_TRUE, if cursors are being looked for only on
11909     * those provided by the rendering engine, @c EINA_FALSE if they
11910     * are being searched on the widget's theme, as well.
11911     *
11912     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
11913     *
11914     * @ingroup Toolbar
11915     */
11916    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11917
11918    /**
11919     * @}
11920     */
11921
11922    /* tooltip */
11923    EAPI double       elm_tooltip_delay_get(void);
11924    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
11925    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
11926    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
11927    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
11928    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);
11929    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11930    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11931    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11932    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
11933    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11934    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11935    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11936    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11937    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
11938    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11939    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
11940    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
11941
11942    /* cursors */
11943    EAPI int          elm_cursor_engine_only_get(void);
11944    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
11945
11946    /**
11947     * @defgroup Menu Menu
11948     *
11949     * @image html img/widget/menu/preview-00.png
11950     * @image latex img/widget/menu/preview-00.eps
11951     *
11952     * A menu is a list of items displayed above its parent. When the menu is
11953     * showing its parent is darkened. Each item can have a sub-menu. The menu
11954     * object can be used to display a menu on a right click event, in a toolbar,
11955     * anywhere.
11956     *
11957     * Signals that you can add callbacks for are:
11958     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
11959     *             event_info is NULL.
11960     *
11961     * @see @ref tutorial_menu
11962     * @{
11963     */
11964    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
11965    /**
11966     * @brief Add a new menu to the parent
11967     *
11968     * @param parent The parent object.
11969     * @return The new object or NULL if it cannot be created.
11970     */
11971    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11972    /**
11973     * @brief Set the parent for the given menu widget
11974     *
11975     * @param obj The menu object.
11976     * @param parent The new parent.
11977     */
11978    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11979    /**
11980     * @brief Get the parent for the given menu widget
11981     *
11982     * @param obj The menu object.
11983     * @return The parent.
11984     *
11985     * @see elm_menu_parent_set()
11986     */
11987    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11988    /**
11989     * @brief Move the menu to a new position
11990     *
11991     * @param obj The menu object.
11992     * @param x The new position.
11993     * @param y The new position.
11994     *
11995     * Sets the top-left position of the menu to (@p x,@p y).
11996     *
11997     * @note @p x and @p y coordinates are relative to parent.
11998     */
11999    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12000    /**
12001     * @brief Close a opened menu
12002     *
12003     * @param obj the menu object
12004     * @return void
12005     *
12006     * Hides the menu and all it's sub-menus.
12007     */
12008    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12009    /**
12010     * @brief Returns a list of @p item's items.
12011     *
12012     * @param obj The menu object
12013     * @return An Eina_List* of @p item's items
12014     */
12015    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12016    /**
12017     * @brief Get the Evas_Object of an Elm_Menu_Item
12018     *
12019     * @param item The menu item object.
12020     * @return The edje object containing the swallowed content
12021     *
12022     * @warning Don't manipulate this object!
12023     */
12024    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12025    /**
12026     * @brief Add an item at the end of the given menu widget
12027     *
12028     * @param obj The menu object.
12029     * @param parent The parent menu item (optional)
12030     * @param icon A icon display on the item. The icon will be destryed by the menu.
12031     * @param label The label of the item.
12032     * @param func Function called when the user select the item.
12033     * @param data Data sent by the callback.
12034     * @return Returns the new item.
12035     */
12036    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);
12037    /**
12038     * @brief Add an object swallowed in an item at the end of the given menu
12039     * widget
12040     *
12041     * @param obj The menu object.
12042     * @param parent The parent menu item (optional)
12043     * @param subobj The object to swallow
12044     * @param func Function called when the user select the item.
12045     * @param data Data sent by the callback.
12046     * @return Returns the new item.
12047     *
12048     * Add an evas object as an item to the menu.
12049     */
12050    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);
12051    /**
12052     * @brief Set the label of a menu item
12053     *
12054     * @param item The menu item object.
12055     * @param label The label to set for @p item
12056     *
12057     * @warning Don't use this funcion on items created with
12058     * elm_menu_item_add_object() or elm_menu_item_separator_add().
12059     */
12060    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12061    /**
12062     * @brief Get the label of a menu item
12063     *
12064     * @param item The menu item object.
12065     * @return The label of @p item
12066     */
12067    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12068    /**
12069     * @brief Set the icon of a menu item to the standard icon with name @p icon
12070     *
12071     * @param item The menu item object.
12072     * @param icon The icon object to set for the content of @p item
12073     *
12074     * Once this icon is set, any previously set icon will be deleted.
12075     */
12076    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12077    /**
12078     * @brief Get the string representation from the icon of a menu item
12079     *
12080     * @param item The menu item object.
12081     * @return The string representation of @p item's icon or NULL
12082     *
12083     * @see elm_menu_item_object_icon_name_set()
12084     */
12085    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12086    /**
12087     * @deprecated Use elm_menu_item_object_icon_name_set()
12088     */
12089    EAPI void               elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2) EINA_DEPRECATED;
12090    /**
12091     * @deprecated Use elm_menu_item_object_icon_name_get()
12092     */
12093    EAPI const char        *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12094    /**
12095     * @brief Set the content object of a menu item
12096     *
12097     * @param item The menu item object
12098     * @param The content object or NULL
12099     * @return EINA_TRUE on success, else EINA_FALSE
12100     *
12101     * Use this function to change the object swallowed by a menu item, deleting
12102     * any previously swallowed object.
12103     */
12104    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12105    /**
12106     * @brief Get the content object of a menu item
12107     *
12108     * @param item The menu item object
12109     * @return The content object or NULL
12110     * @note If @p item was added with elm_menu_item_add_object, this
12111     * function will return the object passed, else it will return the
12112     * icon object.
12113     *
12114     * @see elm_menu_item_object_content_set()
12115     */
12116    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12117    /**
12118     * @deprecated Use elm_menu_item_object_content_get() instead.
12119     */
12120    EAPI Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_DEPRECATED;
12121    /**
12122     * @brief Set the selected state of @p item.
12123     *
12124     * @param item The menu item object.
12125     * @param selected The selected/unselected state of the item
12126     */
12127    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12128    /**
12129     * @brief Get the selected state of @p item.
12130     *
12131     * @param item The menu item object.
12132     * @return The selected/unselected state of the item
12133     *
12134     * @see elm_menu_item_selected_set()
12135     */
12136    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12137    /**
12138     * @brief Set the disabled state of @p item.
12139     *
12140     * @param item The menu item object.
12141     * @param disabled The enabled/disabled state of the item
12142     */
12143    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12144    /**
12145     * @brief Get the disabled state of @p item.
12146     *
12147     * @param item The menu item object.
12148     * @return The enabled/disabled state of the item
12149     *
12150     * @see elm_menu_item_disabled_set()
12151     */
12152    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12153    /**
12154     * @brief Add a separator item to menu @p obj under @p parent.
12155     *
12156     * @param obj The menu object
12157     * @param parent The item to add the separator under
12158     * @return The created item or NULL on failure
12159     *
12160     * This is item is a @ref Separator.
12161     */
12162    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12163    /**
12164     * @brief Returns whether @p item is a separator.
12165     *
12166     * @param item The item to check
12167     * @return If true, @p item is a separator
12168     *
12169     * @see elm_menu_item_separator_add()
12170     */
12171    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12172    /**
12173     * @brief Deletes an item from the menu.
12174     *
12175     * @param item The item to delete.
12176     *
12177     * @see elm_menu_item_add()
12178     */
12179    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12180    /**
12181     * @brief Set the function called when a menu item is deleted.
12182     *
12183     * @param item The item to set the callback on
12184     * @param func The function called
12185     *
12186     * @see elm_menu_item_add()
12187     * @see elm_menu_item_del()
12188     */
12189    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12190    /**
12191     * @brief Returns the data associated with menu item @p item.
12192     *
12193     * @param item The item
12194     * @return The data associated with @p item or NULL if none was set.
12195     *
12196     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12197     */
12198    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12199    /**
12200     * @brief Sets the data to be associated with menu item @p item.
12201     *
12202     * @param item The item
12203     * @param data The data to be associated with @p item
12204     */
12205    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12206    /**
12207     * @brief Returns a list of @p item's subitems.
12208     *
12209     * @param item The item
12210     * @return An Eina_List* of @p item's subitems
12211     *
12212     * @see elm_menu_add()
12213     */
12214    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12215    /**
12216     * @brief Get the position of a menu item
12217     *
12218     * @param item The menu item
12219     * @return The item's index
12220     *
12221     * This function returns the index position of a menu item in a menu.
12222     * For a sub-menu, this number is relative to the first item in the sub-menu.
12223     *
12224     * @note Index values begin with 0
12225     */
12226    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12227    /**
12228     * @brief @brief Return a menu item's owner menu
12229     *
12230     * @param item The menu item
12231     * @return The menu object owning @p item, or NULL on failure
12232     *
12233     * Use this function to get the menu object owning an item.
12234     */
12235    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12236    /**
12237     * @brief Get the selected item in the menu
12238     *
12239     * @param obj The menu object
12240     * @return The selected item, or NULL if none
12241     *
12242     * @see elm_menu_item_selected_get()
12243     * @see elm_menu_item_selected_set()
12244     */
12245    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12246    /**
12247     * @brief Get the last item in the menu
12248     *
12249     * @param obj The menu object
12250     * @return The last item, or NULL if none
12251     */
12252    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12253    /**
12254     * @brief Get the first item in the menu
12255     *
12256     * @param obj The menu object
12257     * @return The first item, or NULL if none
12258     */
12259    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12260    /**
12261     * @brief Get the next item in the menu.
12262     *
12263     * @param item The menu item object.
12264     * @return The item after it, or NULL if none
12265     */
12266    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12267    /**
12268     * @brief Get the previous item in the menu.
12269     *
12270     * @param item The menu item object.
12271     * @return The item before it, or NULL if none
12272     */
12273    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12274    /**
12275     * @}
12276     */
12277
12278    /**
12279     * @defgroup List List
12280     * @ingroup Elementary
12281     *
12282     * @image html img/widget/list/preview-00.png
12283     * @image latex img/widget/list/preview-00.eps width=\textwidth
12284     *
12285     * @image html img/list.png
12286     * @image latex img/list.eps width=\textwidth
12287     *
12288     * A list widget is a container whose children are displayed vertically or
12289     * horizontally, in order, and can be selected.
12290     * The list can accept only one or multiple items selection. Also has many
12291     * modes of items displaying.
12292     *
12293     * A list is a very simple type of list widget.  For more robust
12294     * lists, @ref Genlist should probably be used.
12295     *
12296     * Smart callbacks one can listen to:
12297     * - @c "activated" - The user has double-clicked or pressed
12298     *   (enter|return|spacebar) on an item. The @c event_info parameter
12299     *   is the item that was activated.
12300     * - @c "clicked,double" - The user has double-clicked an item.
12301     *   The @c event_info parameter is the item that was double-clicked.
12302     * - "selected" - when the user selected an item
12303     * - "unselected" - when the user unselected an item
12304     * - "longpressed" - an item in the list is long-pressed
12305     * - "scroll,edge,top" - the list is scrolled until the top edge
12306     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12307     * - "scroll,edge,left" - the list is scrolled until the left edge
12308     * - "scroll,edge,right" - the list is scrolled until the right edge
12309     *
12310     * Available styles for it:
12311     * - @c "default"
12312     *
12313     * List of examples:
12314     * @li @ref list_example_01
12315     * @li @ref list_example_02
12316     * @li @ref list_example_03
12317     */
12318
12319    /**
12320     * @addtogroup List
12321     * @{
12322     */
12323
12324    /**
12325     * @enum _Elm_List_Mode
12326     * @typedef Elm_List_Mode
12327     *
12328     * Set list's resize behavior, transverse axis scroll and
12329     * items cropping. See each mode's description for more details.
12330     *
12331     * @note Default value is #ELM_LIST_SCROLL.
12332     *
12333     * Values <b> don't </b> work as bitmask, only one can be choosen.
12334     *
12335     * @see elm_list_mode_set()
12336     * @see elm_list_mode_get()
12337     *
12338     * @ingroup List
12339     */
12340    typedef enum _Elm_List_Mode
12341      {
12342         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. */
12343         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). */
12344         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. */
12345         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. */
12346         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12347      } Elm_List_Mode;
12348
12349    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().  */
12350
12351    /**
12352     * Add a new list widget to the given parent Elementary
12353     * (container) object.
12354     *
12355     * @param parent The parent object.
12356     * @return a new list widget handle or @c NULL, on errors.
12357     *
12358     * This function inserts a new list widget on the canvas.
12359     *
12360     * @ingroup List
12361     */
12362    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12363
12364    /**
12365     * Starts the list.
12366     *
12367     * @param obj The list object
12368     *
12369     * @note Call before running show() on the list object.
12370     * @warning If not called, it won't display the list properly.
12371     *
12372     * @code
12373     * li = elm_list_add(win);
12374     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12375     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12376     * elm_list_go(li);
12377     * evas_object_show(li);
12378     * @endcode
12379     *
12380     * @ingroup List
12381     */
12382    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12383
12384    /**
12385     * Enable or disable multiple items selection on the list object.
12386     *
12387     * @param obj The list object
12388     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12389     * disable it.
12390     *
12391     * Disabled by default. If disabled, the user can select a single item of
12392     * the list each time. Selected items are highlighted on list.
12393     * If enabled, many items can be selected.
12394     *
12395     * If a selected item is selected again, it will be unselected.
12396     *
12397     * @see elm_list_multi_select_get()
12398     *
12399     * @ingroup List
12400     */
12401    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12402
12403    /**
12404     * Get a value whether multiple items selection is enabled or not.
12405     *
12406     * @see elm_list_multi_select_set() for details.
12407     *
12408     * @param obj The list object.
12409     * @return @c EINA_TRUE means multiple items selection is enabled.
12410     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12411     * @c EINA_FALSE is returned.
12412     *
12413     * @ingroup List
12414     */
12415    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12416
12417    /**
12418     * Set which mode to use for the list object.
12419     *
12420     * @param obj The list object
12421     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12422     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12423     *
12424     * Set list's resize behavior, transverse axis scroll and
12425     * items cropping. See each mode's description for more details.
12426     *
12427     * @note Default value is #ELM_LIST_SCROLL.
12428     *
12429     * Only one can be set, if a previous one was set, it will be changed
12430     * by the new mode set. Bitmask won't work as well.
12431     *
12432     * @see elm_list_mode_get()
12433     *
12434     * @ingroup List
12435     */
12436    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12437
12438    /**
12439     * Get the mode the list is at.
12440     *
12441     * @param obj The list object
12442     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12443     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12444     *
12445     * @note see elm_list_mode_set() for more information.
12446     *
12447     * @ingroup List
12448     */
12449    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12450
12451    /**
12452     * Enable or disable horizontal mode on the list object.
12453     *
12454     * @param obj The list object.
12455     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12456     * disable it, i.e., to enable vertical mode.
12457     *
12458     * @note Vertical mode is set by default.
12459     *
12460     * On horizontal mode items are displayed on list from left to right,
12461     * instead of from top to bottom. Also, the list will scroll horizontally.
12462     * Each item will presents left icon on top and right icon, or end, at
12463     * the bottom.
12464     *
12465     * @see elm_list_horizontal_get()
12466     *
12467     * @ingroup List
12468     */
12469    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12470
12471    /**
12472     * Get a value whether horizontal mode is enabled or not.
12473     *
12474     * @param obj The list object.
12475     * @return @c EINA_TRUE means horizontal mode selection is enabled.
12476     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12477     * @c EINA_FALSE is returned.
12478     *
12479     * @see elm_list_horizontal_set() for details.
12480     *
12481     * @ingroup List
12482     */
12483    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12484
12485    /**
12486     * Enable or disable always select mode on the list object.
12487     *
12488     * @param obj The list object
12489     * @param always_select @c EINA_TRUE to enable always select mode or
12490     * @c EINA_FALSE to disable it.
12491     *
12492     * @note Always select mode is disabled by default.
12493     *
12494     * Default behavior of list items is to only call its callback function
12495     * the first time it's pressed, i.e., when it is selected. If a selected
12496     * item is pressed again, and multi-select is disabled, it won't call
12497     * this function (if multi-select is enabled it will unselect the item).
12498     *
12499     * If always select is enabled, it will call the callback function
12500     * everytime a item is pressed, so it will call when the item is selected,
12501     * and again when a selected item is pressed.
12502     *
12503     * @see elm_list_always_select_mode_get()
12504     * @see elm_list_multi_select_set()
12505     *
12506     * @ingroup List
12507     */
12508    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12509
12510    /**
12511     * Get a value whether always select mode is enabled or not, meaning that
12512     * an item will always call its callback function, even if already selected.
12513     *
12514     * @param obj The list object
12515     * @return @c EINA_TRUE means horizontal mode selection is enabled.
12516     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12517     * @c EINA_FALSE is returned.
12518     *
12519     * @see elm_list_always_select_mode_set() for details.
12520     *
12521     * @ingroup List
12522     */
12523    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12524
12525    /**
12526     * Set bouncing behaviour when the scrolled content reaches an edge.
12527     *
12528     * Tell the internal scroller object whether it should bounce or not
12529     * when it reaches the respective edges for each axis.
12530     *
12531     * @param obj The list object
12532     * @param h_bounce Whether to bounce or not in the horizontal axis.
12533     * @param v_bounce Whether to bounce or not in the vertical axis.
12534     *
12535     * @see elm_scroller_bounce_set()
12536     *
12537     * @ingroup List
12538     */
12539    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12540
12541    /**
12542     * Get the bouncing behaviour of the internal scroller.
12543     *
12544     * Get whether the internal scroller should bounce when the edge of each
12545     * axis is reached scrolling.
12546     *
12547     * @param obj The list object.
12548     * @param h_bounce Pointer where to store the bounce state of the horizontal
12549     * axis.
12550     * @param v_bounce Pointer where to store the bounce state of the vertical
12551     * axis.
12552     *
12553     * @see elm_scroller_bounce_get()
12554     * @see elm_list_bounce_set()
12555     *
12556     * @ingroup List
12557     */
12558    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12559
12560    /**
12561     * Set the scrollbar policy.
12562     *
12563     * @param obj The list object
12564     * @param policy_h Horizontal scrollbar policy.
12565     * @param policy_v Vertical scrollbar policy.
12566     *
12567     * This sets the scrollbar visibility policy for the given scroller.
12568     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12569     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12570     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12571     * This applies respectively for the horizontal and vertical scrollbars.
12572     *
12573     * The both are disabled by default, i.e., are set to
12574     * #ELM_SCROLLER_POLICY_OFF.
12575     *
12576     * @ingroup List
12577     */
12578    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12579
12580    /**
12581     * Get the scrollbar policy.
12582     *
12583     * @see elm_list_scroller_policy_get() for details.
12584     *
12585     * @param obj The list object.
12586     * @param policy_h Pointer where to store horizontal scrollbar policy.
12587     * @param policy_v Pointer where to store vertical scrollbar policy.
12588     *
12589     * @ingroup List
12590     */
12591    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);
12592
12593    /**
12594     * Append a new item to the list object.
12595     *
12596     * @param obj The list object.
12597     * @param label The label of the list item.
12598     * @param icon The icon object to use for the left side of the item. An
12599     * icon can be any Evas object, but usually it is an icon created
12600     * with elm_icon_add().
12601     * @param end The icon object to use for the right side of the item. An
12602     * icon can be any Evas object.
12603     * @param func The function to call when the item is clicked.
12604     * @param data The data to associate with the item for related callbacks.
12605     *
12606     * @return The created item or @c NULL upon failure.
12607     *
12608     * A new item will be created and appended to the list, i.e., will
12609     * be set as @b last item.
12610     *
12611     * Items created with this method can be deleted with
12612     * elm_list_item_del().
12613     *
12614     * Associated @p data can be properly freed when item is deleted if a
12615     * callback function is set with elm_list_item_del_cb_set().
12616     *
12617     * If a function is passed as argument, it will be called everytime this item
12618     * is selected, i.e., the user clicks over an unselected item.
12619     * If always select is enabled it will call this function every time
12620     * user clicks over an item (already selected or not).
12621     * If such function isn't needed, just passing
12622     * @c NULL as @p func is enough. The same should be done for @p data.
12623     *
12624     * Simple example (with no function callback or data associated):
12625     * @code
12626     * li = elm_list_add(win);
12627     * ic = elm_icon_add(win);
12628     * elm_icon_file_set(ic, "path/to/image", NULL);
12629     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12630     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12631     * elm_list_go(li);
12632     * evas_object_show(li);
12633     * @endcode
12634     *
12635     * @see elm_list_always_select_mode_set()
12636     * @see elm_list_item_del()
12637     * @see elm_list_item_del_cb_set()
12638     * @see elm_list_clear()
12639     * @see elm_icon_add()
12640     *
12641     * @ingroup List
12642     */
12643    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);
12644
12645    /**
12646     * Prepend a new item to the list object.
12647     *
12648     * @param obj The list object.
12649     * @param label The label of the list item.
12650     * @param icon The icon object to use for the left side of the item. An
12651     * icon can be any Evas object, but usually it is an icon created
12652     * with elm_icon_add().
12653     * @param end The icon object to use for the right side of the item. An
12654     * icon can be any Evas object.
12655     * @param func The function to call when the item is clicked.
12656     * @param data The data to associate with the item for related callbacks.
12657     *
12658     * @return The created item or @c NULL upon failure.
12659     *
12660     * A new item will be created and prepended to the list, i.e., will
12661     * be set as @b first item.
12662     *
12663     * Items created with this method can be deleted with
12664     * elm_list_item_del().
12665     *
12666     * Associated @p data can be properly freed when item is deleted if a
12667     * callback function is set with elm_list_item_del_cb_set().
12668     *
12669     * If a function is passed as argument, it will be called everytime this item
12670     * is selected, i.e., the user clicks over an unselected item.
12671     * If always select is enabled it will call this function every time
12672     * user clicks over an item (already selected or not).
12673     * If such function isn't needed, just passing
12674     * @c NULL as @p func is enough. The same should be done for @p data.
12675     *
12676     * @see elm_list_item_append() for a simple code example.
12677     * @see elm_list_always_select_mode_set()
12678     * @see elm_list_item_del()
12679     * @see elm_list_item_del_cb_set()
12680     * @see elm_list_clear()
12681     * @see elm_icon_add()
12682     *
12683     * @ingroup List
12684     */
12685    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);
12686
12687    /**
12688     * Insert a new item into the list object before item @p before.
12689     *
12690     * @param obj The list object.
12691     * @param before The list item to insert before.
12692     * @param label The label of the list item.
12693     * @param icon The icon object to use for the left side of the item. An
12694     * icon can be any Evas object, but usually it is an icon created
12695     * with elm_icon_add().
12696     * @param end The icon object to use for the right side of the item. An
12697     * icon can be any Evas object.
12698     * @param func The function to call when the item is clicked.
12699     * @param data The data to associate with the item for related callbacks.
12700     *
12701     * @return The created item or @c NULL upon failure.
12702     *
12703     * A new item will be created and added to the list. Its position in
12704     * this list will be just before item @p before.
12705     *
12706     * Items created with this method can be deleted with
12707     * elm_list_item_del().
12708     *
12709     * Associated @p data can be properly freed when item is deleted if a
12710     * callback function is set with elm_list_item_del_cb_set().
12711     *
12712     * If a function is passed as argument, it will be called everytime this item
12713     * is selected, i.e., the user clicks over an unselected item.
12714     * If always select is enabled it will call this function every time
12715     * user clicks over an item (already selected or not).
12716     * If such function isn't needed, just passing
12717     * @c NULL as @p func is enough. The same should be done for @p data.
12718     *
12719     * @see elm_list_item_append() for a simple code example.
12720     * @see elm_list_always_select_mode_set()
12721     * @see elm_list_item_del()
12722     * @see elm_list_item_del_cb_set()
12723     * @see elm_list_clear()
12724     * @see elm_icon_add()
12725     *
12726     * @ingroup List
12727     */
12728    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);
12729
12730    /**
12731     * Insert a new item into the list object after item @p after.
12732     *
12733     * @param obj The list object.
12734     * @param after The list item to insert after.
12735     * @param label The label of the list item.
12736     * @param icon The icon object to use for the left side of the item. An
12737     * icon can be any Evas object, but usually it is an icon created
12738     * with elm_icon_add().
12739     * @param end The icon object to use for the right side of the item. An
12740     * icon can be any Evas object.
12741     * @param func The function to call when the item is clicked.
12742     * @param data The data to associate with the item for related callbacks.
12743     *
12744     * @return The created item or @c NULL upon failure.
12745     *
12746     * A new item will be created and added to the list. Its position in
12747     * this list will be just after item @p after.
12748     *
12749     * Items created with this method can be deleted with
12750     * elm_list_item_del().
12751     *
12752     * Associated @p data can be properly freed when item is deleted if a
12753     * callback function is set with elm_list_item_del_cb_set().
12754     *
12755     * If a function is passed as argument, it will be called everytime this item
12756     * is selected, i.e., the user clicks over an unselected item.
12757     * If always select is enabled it will call this function every time
12758     * user clicks over an item (already selected or not).
12759     * If such function isn't needed, just passing
12760     * @c NULL as @p func is enough. The same should be done for @p data.
12761     *
12762     * @see elm_list_item_append() for a simple code example.
12763     * @see elm_list_always_select_mode_set()
12764     * @see elm_list_item_del()
12765     * @see elm_list_item_del_cb_set()
12766     * @see elm_list_clear()
12767     * @see elm_icon_add()
12768     *
12769     * @ingroup List
12770     */
12771    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);
12772
12773    /**
12774     * Insert a new item into the sorted list object.
12775     *
12776     * @param obj The list object.
12777     * @param label The label of the list item.
12778     * @param icon The icon object to use for the left side of the item. An
12779     * icon can be any Evas object, but usually it is an icon created
12780     * with elm_icon_add().
12781     * @param end The icon object to use for the right side of the item. An
12782     * icon can be any Evas object.
12783     * @param func The function to call when the item is clicked.
12784     * @param data The data to associate with the item for related callbacks.
12785     * @param cmp_func The comparing function to be used to sort list
12786     * items <b>by #Elm_List_Item item handles</b>. This function will
12787     * receive two items and compare them, returning a non-negative integer
12788     * if the second item should be place after the first, or negative value
12789     * if should be placed before.
12790     *
12791     * @return The created item or @c NULL upon failure.
12792     *
12793     * @note This function inserts values into a list object assuming it was
12794     * sorted and the result will be sorted.
12795     *
12796     * A new item will be created and added to the list. Its position in
12797     * this list will be found comparing the new item with previously inserted
12798     * items using function @p cmp_func.
12799     *
12800     * Items created with this method can be deleted with
12801     * elm_list_item_del().
12802     *
12803     * Associated @p data can be properly freed when item is deleted if a
12804     * callback function is set with elm_list_item_del_cb_set().
12805     *
12806     * If a function is passed as argument, it will be called everytime this item
12807     * is selected, i.e., the user clicks over an unselected item.
12808     * If always select is enabled it will call this function every time
12809     * user clicks over an item (already selected or not).
12810     * If such function isn't needed, just passing
12811     * @c NULL as @p func is enough. The same should be done for @p data.
12812     *
12813     * @see elm_list_item_append() for a simple code example.
12814     * @see elm_list_always_select_mode_set()
12815     * @see elm_list_item_del()
12816     * @see elm_list_item_del_cb_set()
12817     * @see elm_list_clear()
12818     * @see elm_icon_add()
12819     *
12820     * @ingroup List
12821     */
12822    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);
12823
12824    /**
12825     * Remove all list's items.
12826     *
12827     * @param obj The list object
12828     *
12829     * @see elm_list_item_del()
12830     * @see elm_list_item_append()
12831     *
12832     * @ingroup List
12833     */
12834    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12835
12836    /**
12837     * Get a list of all the list items.
12838     *
12839     * @param obj The list object
12840     * @return An @c Eina_List of list items, #Elm_List_Item,
12841     * or @c NULL on failure.
12842     *
12843     * @see elm_list_item_append()
12844     * @see elm_list_item_del()
12845     * @see elm_list_clear()
12846     *
12847     * @ingroup List
12848     */
12849    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12850
12851    /**
12852     * Get the selected item.
12853     *
12854     * @param obj The list object.
12855     * @return The selected list item.
12856     *
12857     * The selected item can be unselected with function
12858     * elm_list_item_selected_set().
12859     *
12860     * The selected item always will be highlighted on list.
12861     *
12862     * @see elm_list_selected_items_get()
12863     *
12864     * @ingroup List
12865     */
12866    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12867
12868    /**
12869     * Return a list of the currently selected list items.
12870     *
12871     * @param obj The list object.
12872     * @return An @c Eina_List of list items, #Elm_List_Item,
12873     * or @c NULL on failure.
12874     *
12875     * Multiple items can be selected if multi select is enabled. It can be
12876     * done with elm_list_multi_select_set().
12877     *
12878     * @see elm_list_selected_item_get()
12879     * @see elm_list_multi_select_set()
12880     *
12881     * @ingroup List
12882     */
12883    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12884
12885    /**
12886     * Set the selected state of an item.
12887     *
12888     * @param item The list item
12889     * @param selected The selected state
12890     *
12891     * This sets the selected state of the given item @p it.
12892     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
12893     *
12894     * If a new item is selected the previosly selected will be unselected,
12895     * unless multiple selection is enabled with elm_list_multi_select_set().
12896     * Previoulsy selected item can be get with function
12897     * elm_list_selected_item_get().
12898     *
12899     * Selected items will be highlighted.
12900     *
12901     * @see elm_list_item_selected_get()
12902     * @see elm_list_selected_item_get()
12903     * @see elm_list_multi_select_set()
12904     *
12905     * @ingroup List
12906     */
12907    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12908
12909    /*
12910     * Get whether the @p item is selected or not.
12911     *
12912     * @param item The list item.
12913     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
12914     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
12915     *
12916     * @see elm_list_selected_item_set() for details.
12917     * @see elm_list_item_selected_get()
12918     *
12919     * @ingroup List
12920     */
12921    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12922
12923    /**
12924     * Set or unset item as a separator.
12925     *
12926     * @param it The list item.
12927     * @param setting @c EINA_TRUE to set item @p it as separator or
12928     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
12929     *
12930     * Items aren't set as separator by default.
12931     *
12932     * If set as separator it will display separator theme, so won't display
12933     * icons or label.
12934     *
12935     * @see elm_list_item_separator_get()
12936     *
12937     * @ingroup List
12938     */
12939    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
12940
12941    /**
12942     * Get a value whether item is a separator or not.
12943     *
12944     * @see elm_list_item_separator_set() for details.
12945     *
12946     * @param it The list item.
12947     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
12948     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
12949     *
12950     * @ingroup List
12951     */
12952    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12953
12954    /**
12955     * Show @p item in the list view.
12956     *
12957     * @param item The list item to be shown.
12958     *
12959     * It won't animate list until item is visible. If such behavior is wanted,
12960     * use elm_list_bring_in() intead.
12961     *
12962     * @ingroup List
12963     */
12964    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12965
12966    /**
12967     * Bring in the given item to list view.
12968     *
12969     * @param item The item.
12970     *
12971     * This causes list to jump to the given item @p item and show it
12972     * (by scrolling), if it is not fully visible.
12973     *
12974     * This may use animation to do so and take a period of time.
12975     *
12976     * If animation isn't wanted, elm_list_item_show() can be used.
12977     *
12978     * @ingroup List
12979     */
12980    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12981
12982    /**
12983     * Delete them item from the list.
12984     *
12985     * @param item The item of list to be deleted.
12986     *
12987     * If deleting all list items is required, elm_list_clear()
12988     * should be used instead of getting items list and deleting each one.
12989     *
12990     * @see elm_list_clear()
12991     * @see elm_list_item_append()
12992     * @see elm_list_item_del_cb_set()
12993     *
12994     * @ingroup List
12995     */
12996    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12997
12998    /**
12999     * Set the function called when a list item is freed.
13000     *
13001     * @param item The item to set the callback on
13002     * @param func The function called
13003     *
13004     * If there is a @p func, then it will be called prior item's memory release.
13005     * That will be called with the following arguments:
13006     * @li item's data;
13007     * @li item's Evas object;
13008     * @li item itself;
13009     *
13010     * This way, a data associated to a list item could be properly freed.
13011     *
13012     * @ingroup List
13013     */
13014    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13015
13016    /**
13017     * Get the data associated to the item.
13018     *
13019     * @param item The list item
13020     * @return The data associated to @p item
13021     *
13022     * The return value is a pointer to data associated to @p item when it was
13023     * created, with function elm_list_item_append() or similar. If no data
13024     * was passed as argument, it will return @c NULL.
13025     *
13026     * @see elm_list_item_append()
13027     *
13028     * @ingroup List
13029     */
13030    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13031
13032    /**
13033     * Get the left side icon associated to the item.
13034     *
13035     * @param item The list item
13036     * @return The left side icon associated to @p item
13037     *
13038     * The return value is a pointer to the icon associated to @p item when
13039     * it was
13040     * created, with function elm_list_item_append() or similar, or later
13041     * with function elm_list_item_icon_set(). If no icon
13042     * was passed as argument, it will return @c NULL.
13043     *
13044     * @see elm_list_item_append()
13045     * @see elm_list_item_icon_set()
13046     *
13047     * @ingroup List
13048     */
13049    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13050
13051    /**
13052     * Set the left side icon associated to the item.
13053     *
13054     * @param item The list item
13055     * @param icon The left side icon object to associate with @p item
13056     *
13057     * The icon object to use at left side of the item. An
13058     * icon can be any Evas object, but usually it is an icon created
13059     * with elm_icon_add().
13060     *
13061     * Once the icon object is set, a previously set one will be deleted.
13062     * @warning Setting the same icon for two items will cause the icon to
13063     * dissapear from the first item.
13064     *
13065     * If an icon was passed as argument on item creation, with function
13066     * elm_list_item_append() or similar, it will be already
13067     * associated to the item.
13068     *
13069     * @see elm_list_item_append()
13070     * @see elm_list_item_icon_get()
13071     *
13072     * @ingroup List
13073     */
13074    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13075
13076    /**
13077     * Get the right side icon associated to the item.
13078     *
13079     * @param item The list item
13080     * @return The right side icon associated to @p item
13081     *
13082     * The return value is a pointer to the icon associated to @p item when
13083     * it was
13084     * created, with function elm_list_item_append() or similar, or later
13085     * with function elm_list_item_icon_set(). If no icon
13086     * was passed as argument, it will return @c NULL.
13087     *
13088     * @see elm_list_item_append()
13089     * @see elm_list_item_icon_set()
13090     *
13091     * @ingroup List
13092     */
13093    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13094
13095    /**
13096     * Set the right side icon associated to the item.
13097     *
13098     * @param item The list item
13099     * @param end The right side icon object to associate with @p item
13100     *
13101     * The icon object to use at right side of the item. An
13102     * icon can be any Evas object, but usually it is an icon created
13103     * with elm_icon_add().
13104     *
13105     * Once the icon object is set, a previously set one will be deleted.
13106     * @warning Setting the same icon for two items will cause the icon to
13107     * dissapear from the first item.
13108     *
13109     * If an icon was passed as argument on item creation, with function
13110     * elm_list_item_append() or similar, it will be already
13111     * associated to the item.
13112     *
13113     * @see elm_list_item_append()
13114     * @see elm_list_item_end_get()
13115     *
13116     * @ingroup List
13117     */
13118    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13119
13120    /**
13121     * Gets the base object of the item.
13122     *
13123     * @param item The list item
13124     * @return The base object associated with @p item
13125     *
13126     * Base object is the @c Evas_Object that represents that item.
13127     *
13128     * @ingroup List
13129     */
13130    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13131
13132    /**
13133     * Get the label of item.
13134     *
13135     * @param item The item of list.
13136     * @return The label of item.
13137     *
13138     * The return value is a pointer to the label associated to @p item when
13139     * it was created, with function elm_list_item_append(), or later
13140     * with function elm_list_item_label_set. If no label
13141     * was passed as argument, it will return @c NULL.
13142     *
13143     * @see elm_list_item_label_set() for more details.
13144     * @see elm_list_item_append()
13145     *
13146     * @ingroup List
13147     */
13148    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13149
13150    /**
13151     * Set the label of item.
13152     *
13153     * @param item The item of list.
13154     * @param text The label of item.
13155     *
13156     * The label to be displayed by the item.
13157     * Label will be placed between left and right side icons (if set).
13158     *
13159     * If a label was passed as argument on item creation, with function
13160     * elm_list_item_append() or similar, it will be already
13161     * displayed by the item.
13162     *
13163     * @see elm_list_item_label_get()
13164     * @see elm_list_item_append()
13165     *
13166     * @ingroup List
13167     */
13168    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13169
13170
13171    /**
13172     * Get the item before @p it in list.
13173     *
13174     * @param it The list item.
13175     * @return The item before @p it, or @c NULL if none or on failure.
13176     *
13177     * @note If it is the first item, @c NULL will be returned.
13178     *
13179     * @see elm_list_item_append()
13180     * @see elm_list_items_get()
13181     *
13182     * @ingroup List
13183     */
13184    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13185
13186    /**
13187     * Get the item after @p it in list.
13188     *
13189     * @param it The list item.
13190     * @return The item after @p it, or @c NULL if none or on failure.
13191     *
13192     * @note If it is the last item, @c NULL will be returned.
13193     *
13194     * @see elm_list_item_append()
13195     * @see elm_list_items_get()
13196     *
13197     * @ingroup List
13198     */
13199    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13200
13201    /**
13202     * Sets the disabled/enabled state of a list item.
13203     *
13204     * @param it The item.
13205     * @param disabled The disabled state.
13206     *
13207     * A disabled item cannot be selected or unselected. It will also
13208     * change its appearance (generally greyed out). This sets the
13209     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13210     * enabled).
13211     *
13212     * @ingroup List
13213     */
13214    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13215
13216    /**
13217     * Get a value whether list item is disabled or not.
13218     *
13219     * @param it The item.
13220     * @return The disabled state.
13221     *
13222     * @see elm_list_item_disabled_set() for more details.
13223     *
13224     * @ingroup List
13225     */
13226    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13227
13228    /**
13229     * Set the text to be shown in a given list item's tooltips.
13230     *
13231     * @param item Target item.
13232     * @param text The text to set in the content.
13233     *
13234     * Setup the text as tooltip to object. The item can have only one tooltip,
13235     * so any previous tooltip data - set with this function or
13236     * elm_list_item_tooltip_content_cb_set() - is removed.
13237     *
13238     * @see elm_object_tooltip_text_set() for more details.
13239     *
13240     * @ingroup List
13241     */
13242    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13243
13244
13245    /**
13246     * @brief Disable size restrictions on an object's tooltip
13247     * @param item The tooltip's anchor object
13248     * @param disable If EINA_TRUE, size restrictions are disabled
13249     * @return EINA_FALSE on failure, EINA_TRUE on success
13250     *
13251     * This function allows a tooltip to expand beyond its parant window's canvas.
13252     * It will instead be limited only by the size of the display.
13253     */
13254    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13255    /**
13256     * @brief Retrieve size restriction state of an object's tooltip
13257     * @param obj The tooltip's anchor object
13258     * @return If EINA_TRUE, size restrictions are disabled
13259     *
13260     * This function returns whether a tooltip is allowed to expand beyond
13261     * its parant window's canvas.
13262     * It will instead be limited only by the size of the display.
13263     */
13264    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13265
13266    /**
13267     * Set the content to be shown in the tooltip item.
13268     *
13269     * Setup the tooltip to item. The item can have only one tooltip,
13270     * so any previous tooltip data is removed. @p func(with @p data) will
13271     * be called every time that need show the tooltip and it should
13272     * return a valid Evas_Object. This object is then managed fully by
13273     * tooltip system and is deleted when the tooltip is gone.
13274     *
13275     * @param item the list item being attached a tooltip.
13276     * @param func the function used to create the tooltip contents.
13277     * @param data what to provide to @a func as callback data/context.
13278     * @param del_cb called when data is not needed anymore, either when
13279     *        another callback replaces @a func, the tooltip is unset with
13280     *        elm_list_item_tooltip_unset() or the owner @a item
13281     *        dies. This callback receives as the first parameter the
13282     *        given @a data, and @c event_info is the item.
13283     *
13284     * @see elm_object_tooltip_content_cb_set() for more details.
13285     *
13286     * @ingroup List
13287     */
13288    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);
13289
13290    /**
13291     * Unset tooltip from item.
13292     *
13293     * @param item list item to remove previously set tooltip.
13294     *
13295     * Remove tooltip from item. The callback provided as del_cb to
13296     * elm_list_item_tooltip_content_cb_set() will be called to notify
13297     * it is not used anymore.
13298     *
13299     * @see elm_object_tooltip_unset() for more details.
13300     * @see elm_list_item_tooltip_content_cb_set()
13301     *
13302     * @ingroup List
13303     */
13304    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13305
13306    /**
13307     * Sets a different style for this item tooltip.
13308     *
13309     * @note before you set a style you should define a tooltip with
13310     *       elm_list_item_tooltip_content_cb_set() or
13311     *       elm_list_item_tooltip_text_set()
13312     *
13313     * @param item list item with tooltip already set.
13314     * @param style the theme style to use (default, transparent, ...)
13315     *
13316     * @see elm_object_tooltip_style_set() for more details.
13317     *
13318     * @ingroup List
13319     */
13320    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13321
13322    /**
13323     * Get the style for this item tooltip.
13324     *
13325     * @param item list item with tooltip already set.
13326     * @return style the theme style in use, defaults to "default". If the
13327     *         object does not have a tooltip set, then NULL is returned.
13328     *
13329     * @see elm_object_tooltip_style_get() for more details.
13330     * @see elm_list_item_tooltip_style_set()
13331     *
13332     * @ingroup List
13333     */
13334    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13335
13336    /**
13337     * Set the type of mouse pointer/cursor decoration to be shown,
13338     * when the mouse pointer is over the given list widget item
13339     *
13340     * @param item list item to customize cursor on
13341     * @param cursor the cursor type's name
13342     *
13343     * This function works analogously as elm_object_cursor_set(), but
13344     * here the cursor's changing area is restricted to the item's
13345     * area, and not the whole widget's. Note that that item cursors
13346     * have precedence over widget cursors, so that a mouse over an
13347     * item with custom cursor set will always show @b that cursor.
13348     *
13349     * If this function is called twice for an object, a previously set
13350     * cursor will be unset on the second call.
13351     *
13352     * @see elm_object_cursor_set()
13353     * @see elm_list_item_cursor_get()
13354     * @see elm_list_item_cursor_unset()
13355     *
13356     * @ingroup List
13357     */
13358    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13359
13360    /*
13361     * Get the type of mouse pointer/cursor decoration set to be shown,
13362     * when the mouse pointer is over the given list widget item
13363     *
13364     * @param item list item with custom cursor set
13365     * @return the cursor type's name or @c NULL, if no custom cursors
13366     * were set to @p item (and on errors)
13367     *
13368     * @see elm_object_cursor_get()
13369     * @see elm_list_item_cursor_set()
13370     * @see elm_list_item_cursor_unset()
13371     *
13372     * @ingroup List
13373     */
13374    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13375
13376    /**
13377     * Unset any custom mouse pointer/cursor decoration set to be
13378     * shown, when the mouse pointer is over the given list widget
13379     * item, thus making it show the @b default cursor again.
13380     *
13381     * @param item a list item
13382     *
13383     * Use this call to undo any custom settings on this item's cursor
13384     * decoration, bringing it back to defaults (no custom style set).
13385     *
13386     * @see elm_object_cursor_unset()
13387     * @see elm_list_item_cursor_set()
13388     *
13389     * @ingroup List
13390     */
13391    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13392
13393    /**
13394     * Set a different @b style for a given custom cursor set for a
13395     * list item.
13396     *
13397     * @param item list item with custom cursor set
13398     * @param style the <b>theme style</b> to use (e.g. @c "default",
13399     * @c "transparent", etc)
13400     *
13401     * This function only makes sense when one is using custom mouse
13402     * cursor decorations <b>defined in a theme file</b>, which can have,
13403     * given a cursor name/type, <b>alternate styles</b> on it. It
13404     * works analogously as elm_object_cursor_style_set(), but here
13405     * applyed only to list item objects.
13406     *
13407     * @warning Before you set a cursor style you should have definen a
13408     *       custom cursor previously on the item, with
13409     *       elm_list_item_cursor_set()
13410     *
13411     * @see elm_list_item_cursor_engine_only_set()
13412     * @see elm_list_item_cursor_style_get()
13413     *
13414     * @ingroup List
13415     */
13416    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13417
13418    /**
13419     * Get the current @b style set for a given list item's custom
13420     * cursor
13421     *
13422     * @param item list item with custom cursor set.
13423     * @return style the cursor style in use. If the object does not
13424     *         have a cursor set, then @c NULL is returned.
13425     *
13426     * @see elm_list_item_cursor_style_set() for more details
13427     *
13428     * @ingroup List
13429     */
13430    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13431
13432    /**
13433     * Set if the (custom)cursor for a given list item should be
13434     * searched in its theme, also, or should only rely on the
13435     * rendering engine.
13436     *
13437     * @param item item with custom (custom) cursor already set on
13438     * @param engine_only Use @c EINA_TRUE to have cursors looked for
13439     * only on those provided by the rendering engine, @c EINA_FALSE to
13440     * have them searched on the widget's theme, as well.
13441     *
13442     * @note This call is of use only if you've set a custom cursor
13443     * for list items, with elm_list_item_cursor_set().
13444     *
13445     * @note By default, cursors will only be looked for between those
13446     * provided by the rendering engine.
13447     *
13448     * @ingroup List
13449     */
13450    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13451
13452    /**
13453     * Get if the (custom) cursor for a given list item is being
13454     * searched in its theme, also, or is only relying on the rendering
13455     * engine.
13456     *
13457     * @param item a list item
13458     * @return @c EINA_TRUE, if cursors are being looked for only on
13459     * those provided by the rendering engine, @c EINA_FALSE if they
13460     * are being searched on the widget's theme, as well.
13461     *
13462     * @see elm_list_item_cursor_engine_only_set(), for more details
13463     *
13464     * @ingroup List
13465     */
13466    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13467
13468    /**
13469     * @}
13470     */
13471
13472    /**
13473     * @defgroup Slider Slider
13474     * @ingroup Elementary
13475     *
13476     * @image html img/widget/slider/preview-00.png
13477     * @image latex img/widget/slider/preview-00.eps width=\textwidth
13478     *
13479     * The slider adds a dragable “slider” widget for selecting the value of
13480     * something within a range.
13481     *
13482     * A slider can be horizontal or vertical. It can contain an Icon and has a
13483     * primary label as well as a units label (that is formatted with floating
13484     * point values and thus accepts a printf-style format string, like
13485     * “%1.2f units”. There is also an indicator string that may be somewhere
13486     * else (like on the slider itself) that also accepts a format string like
13487     * units. Label, Icon Unit and Indicator strings/objects are optional.
13488     *
13489     * A slider may be inverted which means values invert, with high vales being
13490     * on the left or top and low values on the right or bottom (as opposed to
13491     * normally being low on the left or top and high on the bottom and right).
13492     *
13493     * The slider should have its minimum and maximum values set by the
13494     * application with  elm_slider_min_max_set() and value should also be set by
13495     * the application before use with  elm_slider_value_set(). The span of the
13496     * slider is its length (horizontally or vertically). This will be scaled by
13497     * the object or applications scaling factor. At any point code can query the
13498     * slider for its value with elm_slider_value_get().
13499     *
13500     * Smart callbacks one can listen to:
13501     * - "changed" - Whenever the slider value is changed by the user.
13502     * - "slider,drag,start" - dragging the slider indicator around has started.
13503     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13504     * - "delay,changed" - A short time after the value is changed by the user.
13505     * This will be called only when the user stops dragging for
13506     * a very short period or when they release their
13507     * finger/mouse, so it avoids possibly expensive reactions to
13508     * the value change.
13509     *
13510     * Available styles for it:
13511     * - @c "default"
13512     *
13513     * Here is an example on its usage:
13514     * @li @ref slider_example
13515     */
13516
13517    /**
13518     * @addtogroup Slider
13519     * @{
13520     */
13521
13522    /**
13523     * Add a new slider widget to the given parent Elementary
13524     * (container) object.
13525     *
13526     * @param parent The parent object.
13527     * @return a new slider widget handle or @c NULL, on errors.
13528     *
13529     * This function inserts a new slider widget on the canvas.
13530     *
13531     * @ingroup Slider
13532     */
13533    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13534
13535    /**
13536     * Set the label of a given slider widget
13537     *
13538     * @param obj The progress bar object
13539     * @param label The text label string, in UTF-8
13540     *
13541     * @ingroup Slider
13542     * @deprecated use elm_object_text_set() instead.
13543     */
13544    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13545
13546    /**
13547     * Get the label of a given slider widget
13548     *
13549     * @param obj The progressbar object
13550     * @return The text label string, in UTF-8
13551     *
13552     * @ingroup Slider
13553     * @deprecated use elm_object_text_get() instead.
13554     */
13555    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13556
13557    /**
13558     * Set the icon object of the slider object.
13559     *
13560     * @param obj The slider object.
13561     * @param icon The icon object.
13562     *
13563     * On horizontal mode, icon is placed at left, and on vertical mode,
13564     * placed at top.
13565     *
13566     * @note Once the icon object is set, a previously set one will be deleted.
13567     * If you want to keep that old content object, use the
13568     * elm_slider_icon_unset() function.
13569     *
13570     * @warning If the object being set does not have minimum size hints set,
13571     * it won't get properly displayed.
13572     *
13573     * @ingroup Slider
13574     */
13575    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13576
13577    /**
13578     * Unset an icon set on a given slider widget.
13579     *
13580     * @param obj The slider object.
13581     * @return The icon object that was being used, if any was set, or
13582     * @c NULL, otherwise (and on errors).
13583     *
13584     * On horizontal mode, icon is placed at left, and on vertical mode,
13585     * placed at top.
13586     *
13587     * This call will unparent and return the icon object which was set
13588     * for this widget, previously, on success.
13589     *
13590     * @see elm_slider_icon_set() for more details
13591     * @see elm_slider_icon_get()
13592     *
13593     * @ingroup Slider
13594     */
13595    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13596
13597    /**
13598     * Retrieve the icon object set for a given slider widget.
13599     *
13600     * @param obj The slider object.
13601     * @return The icon object's handle, if @p obj had one set, or @c NULL,
13602     * otherwise (and on errors).
13603     *
13604     * On horizontal mode, icon is placed at left, and on vertical mode,
13605     * placed at top.
13606     *
13607     * @see elm_slider_icon_set() for more details
13608     * @see elm_slider_icon_unset()
13609     *
13610     * @ingroup Slider
13611     */
13612    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13613
13614    /**
13615     * Set the end object of the slider object.
13616     *
13617     * @param obj The slider object.
13618     * @param end The end object.
13619     *
13620     * On horizontal mode, end is placed at left, and on vertical mode,
13621     * placed at bottom.
13622     *
13623     * @note Once the icon object is set, a previously set one will be deleted.
13624     * If you want to keep that old content object, use the
13625     * elm_slider_end_unset() function.
13626     *
13627     * @warning If the object being set does not have minimum size hints set,
13628     * it won't get properly displayed.
13629     *
13630     * @ingroup Slider
13631     */
13632    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13633
13634    /**
13635     * Unset an end object set on a given slider widget.
13636     *
13637     * @param obj The slider object.
13638     * @return The end object that was being used, if any was set, or
13639     * @c NULL, otherwise (and on errors).
13640     *
13641     * On horizontal mode, end is placed at left, and on vertical mode,
13642     * placed at bottom.
13643     *
13644     * This call will unparent and return the icon object which was set
13645     * for this widget, previously, on success.
13646     *
13647     * @see elm_slider_end_set() for more details.
13648     * @see elm_slider_end_get()
13649     *
13650     * @ingroup Slider
13651     */
13652    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13653
13654    /**
13655     * Retrieve the end object set for a given slider widget.
13656     *
13657     * @param obj The slider object.
13658     * @return The end object's handle, if @p obj had one set, or @c NULL,
13659     * otherwise (and on errors).
13660     *
13661     * On horizontal mode, icon is placed at right, and on vertical mode,
13662     * placed at bottom.
13663     *
13664     * @see elm_slider_end_set() for more details.
13665     * @see elm_slider_end_unset()
13666     *
13667     * @ingroup Slider
13668     */
13669    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13670
13671    /**
13672     * Set the (exact) length of the bar region of a given slider widget.
13673     *
13674     * @param obj The slider object.
13675     * @param size The length of the slider's bar region.
13676     *
13677     * This sets the minimum width (when in horizontal mode) or height
13678     * (when in vertical mode) of the actual bar area of the slider
13679     * @p obj. This in turn affects the object's minimum size. Use
13680     * this when you're not setting other size hints expanding on the
13681     * given direction (like weight and alignment hints) and you would
13682     * like it to have a specific size.
13683     *
13684     * @note Icon, end, label, indicator and unit text around @p obj
13685     * will require their
13686     * own space, which will make @p obj to require more the @p size,
13687     * actually.
13688     *
13689     * @see elm_slider_span_size_get()
13690     *
13691     * @ingroup Slider
13692     */
13693    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13694
13695    /**
13696     * Get the length set for the bar region of a given slider widget
13697     *
13698     * @param obj The slider object.
13699     * @return The length of the slider's bar region.
13700     *
13701     * If that size was not set previously, with
13702     * elm_slider_span_size_set(), this call will return @c 0.
13703     *
13704     * @ingroup Slider
13705     */
13706    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13707
13708    /**
13709     * Set the format string for the unit label.
13710     *
13711     * @param obj The slider object.
13712     * @param format The format string for the unit display.
13713     *
13714     * Unit label is displayed all the time, if set, after slider's bar.
13715     * In horizontal mode, at right and in vertical mode, at bottom.
13716     *
13717     * If @c NULL, unit label won't be visible. If not it sets the format
13718     * string for the label text. To the label text is provided a floating point
13719     * value, so the label text can display up to 1 floating point value.
13720     * Note that this is optional.
13721     *
13722     * Use a format string such as "%1.2f meters" for example, and it will
13723     * display values like: "3.14 meters" for a value equal to 3.14159.
13724     *
13725     * Default is unit label disabled.
13726     *
13727     * @see elm_slider_indicator_format_get()
13728     *
13729     * @ingroup Slider
13730     */
13731    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13732
13733    /**
13734     * Get the unit label format of the slider.
13735     *
13736     * @param obj The slider object.
13737     * @return The unit label format string in UTF-8.
13738     *
13739     * Unit label is displayed all the time, if set, after slider's bar.
13740     * In horizontal mode, at right and in vertical mode, at bottom.
13741     *
13742     * @see elm_slider_unit_format_set() for more
13743     * information on how this works.
13744     *
13745     * @ingroup Slider
13746     */
13747    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13748
13749    /**
13750     * Set the format string for the indicator label.
13751     *
13752     * @param obj The slider object.
13753     * @param indicator The format string for the indicator display.
13754     *
13755     * The slider may display its value somewhere else then unit label,
13756     * for example, above the slider knob that is dragged around. This function
13757     * sets the format string used for this.
13758     *
13759     * If @c NULL, indicator label won't be visible. If not it sets the format
13760     * string for the label text. To the label text is provided a floating point
13761     * value, so the label text can display up to 1 floating point value.
13762     * Note that this is optional.
13763     *
13764     * Use a format string such as "%1.2f meters" for example, and it will
13765     * display values like: "3.14 meters" for a value equal to 3.14159.
13766     *
13767     * Default is indicator label disabled.
13768     *
13769     * @see elm_slider_indicator_format_get()
13770     *
13771     * @ingroup Slider
13772     */
13773    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13774
13775    /**
13776     * Get the indicator label format of the slider.
13777     *
13778     * @param obj The slider object.
13779     * @return The indicator label format string in UTF-8.
13780     *
13781     * The slider may display its value somewhere else then unit label,
13782     * for example, above the slider knob that is dragged around. This function
13783     * gets the format string used for this.
13784     *
13785     * @see elm_slider_indicator_format_set() for more
13786     * information on how this works.
13787     *
13788     * @ingroup Slider
13789     */
13790    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13791
13792    /**
13793     * Set the format function pointer for the indicator label
13794     *
13795     * @param obj The slider object.
13796     * @param func The indicator format function.
13797     * @param free_func The freeing function for the format string.
13798     *
13799     * Set the callback function to format the indicator string.
13800     *
13801     * @see elm_slider_indicator_format_set() for more info on how this works.
13802     *
13803     * @ingroup Slider
13804     */
13805   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);
13806
13807   /**
13808    * Set the format function pointer for the units label
13809    *
13810    * @param obj The slider object.
13811    * @param func The units format function.
13812    * @param free_func The freeing function for the format string.
13813    *
13814    * Set the callback function to format the indicator string.
13815    *
13816    * @see elm_slider_units_format_set() for more info on how this works.
13817    *
13818    * @ingroup Slider
13819    */
13820   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);
13821
13822   /**
13823    * Set the orientation of a given slider widget.
13824    *
13825    * @param obj The slider object.
13826    * @param horizontal Use @c EINA_TRUE to make @p obj to be
13827    * @b horizontal, @c EINA_FALSE to make it @b vertical.
13828    *
13829    * Use this function to change how your slider is to be
13830    * disposed: vertically or horizontally.
13831    *
13832    * By default it's displayed horizontally.
13833    *
13834    * @see elm_slider_horizontal_get()
13835    *
13836    * @ingroup Slider
13837    */
13838    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13839
13840    /**
13841     * Retrieve the orientation of a given slider widget
13842     *
13843     * @param obj The slider object.
13844     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
13845     * @c EINA_FALSE if it's @b vertical (and on errors).
13846     *
13847     * @see elm_slider_horizontal_set() for more details.
13848     *
13849     * @ingroup Slider
13850     */
13851    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13852
13853    /**
13854     * Set the minimum and maximum values for the slider.
13855     *
13856     * @param obj The slider object.
13857     * @param min The minimum value.
13858     * @param max The maximum value.
13859     *
13860     * Define the allowed range of values to be selected by the user.
13861     *
13862     * If actual value is less than @p min, it will be updated to @p min. If it
13863     * is bigger then @p max, will be updated to @p max. Actual value can be
13864     * get with elm_slider_value_get().
13865     *
13866     * By default, min is equal to 0.0, and max is equal to 1.0.
13867     *
13868     * @warning Maximum must be greater than minimum, otherwise behavior
13869     * is undefined.
13870     *
13871     * @see elm_slider_min_max_get()
13872     *
13873     * @ingroup Slider
13874     */
13875    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
13876
13877    /**
13878     * Get the minimum and maximum values of the slider.
13879     *
13880     * @param obj The slider object.
13881     * @param min Pointer where to store the minimum value.
13882     * @param max Pointer where to store the maximum value.
13883     *
13884     * @note If only one value is needed, the other pointer can be passed
13885     * as @c NULL.
13886     *
13887     * @see elm_slider_min_max_set() for details.
13888     *
13889     * @ingroup Slider
13890     */
13891    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
13892
13893    /**
13894     * Set the value the slider displays.
13895     *
13896     * @param obj The slider object.
13897     * @param val The value to be displayed.
13898     *
13899     * Value will be presented on the unit label following format specified with
13900     * elm_slider_unit_format_set() and on indicator with
13901     * elm_slider_indicator_format_set().
13902     *
13903     * @warning The value must to be between min and max values. This values
13904     * are set by elm_slider_min_max_set().
13905     *
13906     * @see elm_slider_value_get()
13907     * @see elm_slider_unit_format_set()
13908     * @see elm_slider_indicator_format_set()
13909     * @see elm_slider_min_max_set()
13910     *
13911     * @ingroup Slider
13912     */
13913    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13914
13915    /**
13916     * Get the value displayed by the spinner.
13917     *
13918     * @param obj The spinner object.
13919     * @return The value displayed.
13920     *
13921     * @see elm_spinner_value_set() for details.
13922     *
13923     * @ingroup Slider
13924     */
13925    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13926
13927    /**
13928     * Invert a given slider widget's displaying values order
13929     *
13930     * @param obj The slider object.
13931     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
13932     * @c EINA_FALSE to bring it back to default, non-inverted values.
13933     *
13934     * A slider may be @b inverted, in which state it gets its
13935     * values inverted, with high vales being on the left or top and
13936     * low values on the right or bottom, as opposed to normally have
13937     * the low values on the former and high values on the latter,
13938     * respectively, for horizontal and vertical modes.
13939     *
13940     * @see elm_slider_inverted_get()
13941     *
13942     * @ingroup Slider
13943     */
13944    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
13945
13946    /**
13947     * Get whether a given slider widget's displaying values are
13948     * inverted or not.
13949     *
13950     * @param obj The slider object.
13951     * @return @c EINA_TRUE, if @p obj has inverted values,
13952     * @c EINA_FALSE otherwise (and on errors).
13953     *
13954     * @see elm_slider_inverted_set() for more details.
13955     *
13956     * @ingroup Slider
13957     */
13958    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13959
13960    /**
13961     * Set whether to enlarge slider indicator (augmented knob) or not.
13962     *
13963     * @param obj The slider object.
13964     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
13965     * let the knob always at default size.
13966     *
13967     * By default, indicator will be bigger while dragged by the user.
13968     *
13969     * @warning It won't display values set with
13970     * elm_slider_indicator_format_set() if you disable indicator.
13971     *
13972     * @ingroup Slider
13973     */
13974    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
13975
13976    /**
13977     * Get whether a given slider widget's enlarging indicator or not.
13978     *
13979     * @param obj The slider object.
13980     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
13981     * @c EINA_FALSE otherwise (and on errors).
13982     *
13983     * @see elm_slider_indicator_show_set() for details.
13984     *
13985     * @ingroup Slider
13986     */
13987    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13988
13989    /**
13990     * @}
13991     */
13992
13993    /**
13994     * @addtogroup Actionslider Actionslider
13995     *
13996     * @image html img/widget/actionslider/preview-00.png
13997     * @image latex img/widget/actionslider/preview-00.eps
13998     *
13999     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
14000     * properties. The indicator is the element the user drags to choose a label.
14001     * When the position is set with magnet, when released the indicator will be
14002     * moved to it if it's nearest the magnetized position.
14003     *
14004     * @note By default all positions are set as enabled.
14005     *
14006     * Signals that you can add callbacks for are:
14007     *
14008     * "selected" - when user selects an enabled position (the label is passed
14009     *              as event info)".
14010     * @n
14011     * "pos_changed" - when the indicator reaches any of the positions("left",
14012     *                 "right" or "center").
14013     *
14014     * See an example of actionslider usage @ref actionslider_example_page "here"
14015     * @{
14016     */
14017    typedef enum _Elm_Actionslider_Pos
14018      {
14019         ELM_ACTIONSLIDER_NONE = 0,
14020         ELM_ACTIONSLIDER_LEFT = 1 << 0,
14021         ELM_ACTIONSLIDER_CENTER = 1 << 1,
14022         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14023         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14024      } Elm_Actionslider_Pos;
14025
14026    /**
14027     * Add a new actionslider to the parent.
14028     *
14029     * @param parent The parent object
14030     * @return The new actionslider object or NULL if it cannot be created
14031     */
14032    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14033    /**
14034     * Set actionslider labels.
14035     *
14036     * @param obj The actionslider object
14037     * @param left_label The label to be set on the left.
14038     * @param center_label The label to be set on the center.
14039     * @param right_label The label to be set on the right.
14040     * @deprecated use elm_object_text_set() instead.
14041     */
14042    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);
14043    /**
14044     * Get actionslider labels.
14045     *
14046     * @param obj The actionslider object
14047     * @param left_label A char** to place the left_label of @p obj into.
14048     * @param center_label A char** to place the center_label of @p obj into.
14049     * @param right_label A char** to place the right_label of @p obj into.
14050     * @deprecated use elm_object_text_set() instead.
14051     */
14052    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);
14053    /**
14054     * Get actionslider selected label.
14055     *
14056     * @param obj The actionslider object
14057     * @return The selected label
14058     */
14059    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14060    /**
14061     * Set actionslider indicator position.
14062     *
14063     * @param obj The actionslider object.
14064     * @param pos The position of the indicator.
14065     */
14066    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14067    /**
14068     * Get actionslider indicator position.
14069     *
14070     * @param obj The actionslider object.
14071     * @return The position of the indicator.
14072     */
14073    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14074    /**
14075     * Set actionslider magnet position. To make multiple positions magnets @c or
14076     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14077     *
14078     * @param obj The actionslider object.
14079     * @param pos Bit mask indicating the magnet positions.
14080     */
14081    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14082    /**
14083     * Get actionslider magnet position.
14084     *
14085     * @param obj The actionslider object.
14086     * @return The positions with magnet property.
14087     */
14088    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14089    /**
14090     * Set actionslider enabled position. To set multiple positions as enabled @c or
14091     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14092     *
14093     * @note All the positions are enabled by default.
14094     *
14095     * @param obj The actionslider object.
14096     * @param pos Bit mask indicating the enabled positions.
14097     */
14098    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14099    /**
14100     * Get actionslider enabled position.
14101     *
14102     * @param obj The actionslider object.
14103     * @return The enabled positions.
14104     */
14105    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14106    /**
14107     * Set the label used on the indicator.
14108     *
14109     * @param obj The actionslider object
14110     * @param label The label to be set on the indicator.
14111     * @deprecated use elm_object_text_set() instead.
14112     */
14113    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14114    /**
14115     * Get the label used on the indicator object.
14116     *
14117     * @param obj The actionslider object
14118     * @return The indicator label
14119     * @deprecated use elm_object_text_get() instead.
14120     */
14121    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14122    /**
14123     * @}
14124     */
14125
14126    /**
14127     * @defgroup Genlist Genlist
14128     *
14129     * @image html img/widget/genlist/preview-00.png
14130     * @image latex img/widget/genlist/preview-00.eps
14131     * @image html img/genlist.png
14132     * @image latex img/genlist.eps
14133     *
14134     * This widget aims to have more expansive list than the simple list in
14135     * Elementary that could have more flexible items and allow many more entries
14136     * while still being fast and low on memory usage. At the same time it was
14137     * also made to be able to do tree structures. But the price to pay is more
14138     * complexity when it comes to usage. If all you want is a simple list with
14139     * icons and a single label, use the normal @ref List object.
14140     *
14141     * Genlist has a fairly large API, mostly because it's relatively complex,
14142     * trying to be both expansive, powerful and efficient. First we will begin
14143     * an overview on the theory behind genlist.
14144     *
14145     * @section Genlist_Item_Class Genlist item classes - creating items
14146     *
14147     * In order to have the ability to add and delete items on the fly, genlist
14148     * implements a class (callback) system where the application provides a
14149     * structure with information about that type of item (genlist may contain
14150     * multiple different items with different classes, states and styles).
14151     * Genlist will call the functions in this struct (methods) when an item is
14152     * "realized" (i.e., created dynamically, while the user is scrolling the
14153     * grid). All objects will simply be deleted when no longer needed with
14154     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14155     * following members:
14156     * - @c item_style - This is a constant string and simply defines the name
14157     *   of the item style. It @b must be specified and the default should be @c
14158     *   "default".
14159     * - @c mode_item_style - This is a constant string and simply defines the
14160     *   name of the style that will be used for mode animations. It can be left
14161     *   as @c NULL if you don't plan to use Genlist mode. See
14162     *   elm_genlist_item_mode_set() for more info.
14163     *
14164     * - @c func - A struct with pointers to functions that will be called when
14165     *   an item is going to be actually created. All of them receive a @c data
14166     *   parameter that will point to the same data passed to
14167     *   elm_genlist_item_append() and related item creation functions, and a @c
14168     *   obj parameter that points to the genlist object itself.
14169     *
14170     * The function pointers inside @c func are @c label_get, @c icon_get, @c
14171     * state_get and @c del. The 3 first functions also receive a @c part
14172     * parameter described below. A brief description of these functions follows:
14173     *
14174     * - @c label_get - The @c part parameter is the name string of one of the
14175     *   existing text parts in the Edje group implementing the item's theme.
14176     *   This function @b must return a strdup'()ed string, as the caller will
14177     *   free() it when done. See #GenlistItemLabelGetFunc.
14178     * - @c icon_get - The @c part parameter is the name string of one of the
14179     *   existing (icon) swallow parts in the Edje group implementing the item's
14180     *   theme. It must return @c NULL, when no icon is desired, or a valid
14181     *   object handle, otherwise.  The object will be deleted by the genlist on
14182     *   its deletion or when the item is "unrealized".  See
14183     *   #GenlistItemIconGetFunc.
14184     * - @c func.state_get - The @c part parameter is the name string of one of
14185     *   the state parts in the Edje group implementing the item's theme. Return
14186     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14187     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14188     *   and @c "elm" as "emission" and "source" arguments, respectively, when
14189     *   the state is true (the default is false), where @c XXX is the name of
14190     *   the (state) part.  See #GenlistItemStateGetFunc.
14191     * - @c func.del - This is intended for use when genlist items are deleted,
14192     *   so any data attached to the item (e.g. its data parameter on creation)
14193     *   can be deleted. See #GenlistItemDelFunc.
14194     *
14195     * available item styles:
14196     * - default
14197     * - default_style - The text part is a textblock
14198     *
14199     * @image html img/widget/genlist/preview-04.png
14200     * @image latex img/widget/genlist/preview-04.eps
14201     *
14202     * - double_label
14203     *
14204     * @image html img/widget/genlist/preview-01.png
14205     * @image latex img/widget/genlist/preview-01.eps
14206     *
14207     * - icon_top_text_bottom
14208     *
14209     * @image html img/widget/genlist/preview-02.png
14210     * @image latex img/widget/genlist/preview-02.eps
14211     *
14212     * - group_index
14213     *
14214     * @image html img/widget/genlist/preview-03.png
14215     * @image latex img/widget/genlist/preview-03.eps
14216     *
14217     * @section Genlist_Items Structure of items
14218     *
14219     * An item in a genlist can have 0 or more text labels (they can be regular
14220     * text or textblock Evas objects - that's up to the style to determine), 0
14221     * or more icons (which are simply objects swallowed into the genlist item's
14222     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14223     * behavior left to the user to define. The Edje part names for each of
14224     * these properties will be looked up, in the theme file for the genlist,
14225     * under the Edje (string) data items named @c "labels", @c "icons" and @c
14226     * "states", respectively. For each of those properties, if more than one
14227     * part is provided, they must have names listed separated by spaces in the
14228     * data fields. For the default genlist item theme, we have @b one label
14229     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14230     * "elm.swallow.end") and @b no state parts.
14231     *
14232     * A genlist item may be at one of several styles. Elementary provides one
14233     * by default - "default", but this can be extended by system or application
14234     * custom themes/overlays/extensions (see @ref Theme "themes" for more
14235     * details).
14236     *
14237     * @section Genlist_Manipulation Editing and Navigating
14238     *
14239     * Items can be added by several calls. All of them return a @ref
14240     * Elm_Genlist_Item handle that is an internal member inside the genlist.
14241     * They all take a data parameter that is meant to be used for a handle to
14242     * the applications internal data (eg the struct with the original item
14243     * data). The parent parameter is the parent genlist item this belongs to if
14244     * it is a tree or an indexed group, and NULL if there is no parent. The
14245     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14246     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14247     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14248     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
14249     * is set then this item is group index item that is displayed at the top
14250     * until the next group comes. The func parameter is a convenience callback
14251     * that is called when the item is selected and the data parameter will be
14252     * the func_data parameter, obj be the genlist object and event_info will be
14253     * the genlist item.
14254     *
14255     * elm_genlist_item_append() adds an item to the end of the list, or if
14256     * there is a parent, to the end of all the child items of the parent.
14257     * elm_genlist_item_prepend() is the same but adds to the beginning of
14258     * the list or children list. elm_genlist_item_insert_before() inserts at
14259     * item before another item and elm_genlist_item_insert_after() inserts after
14260     * the indicated item.
14261     *
14262     * The application can clear the list with elm_genlist_clear() which deletes
14263     * all the items in the list and elm_genlist_item_del() will delete a specific
14264     * item. elm_genlist_item_subitems_clear() will clear all items that are
14265     * children of the indicated parent item.
14266     *
14267     * To help inspect list items you can jump to the item at the top of the list
14268     * with elm_genlist_first_item_get() which will return the item pointer, and
14269     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14270     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14271     * and previous items respectively relative to the indicated item. Using
14272     * these calls you can walk the entire item list/tree. Note that as a tree
14273     * the items are flattened in the list, so elm_genlist_item_parent_get() will
14274     * let you know which item is the parent (and thus know how to skip them if
14275     * wanted).
14276     *
14277     * @section Genlist_Muti_Selection Multi-selection
14278     *
14279     * If the application wants multiple items to be able to be selected,
14280     * elm_genlist_multi_select_set() can enable this. If the list is
14281     * single-selection only (the default), then elm_genlist_selected_item_get()
14282     * will return the selected item, if any, or NULL I none is selected. If the
14283     * list is multi-select then elm_genlist_selected_items_get() will return a
14284     * list (that is only valid as long as no items are modified (added, deleted,
14285     * selected or unselected)).
14286     *
14287     * @section Genlist_Usage_Hints Usage hints
14288     *
14289     * There are also convenience functions. elm_genlist_item_genlist_get() will
14290     * return the genlist object the item belongs to. elm_genlist_item_show()
14291     * will make the scroller scroll to show that specific item so its visible.
14292     * elm_genlist_item_data_get() returns the data pointer set by the item
14293     * creation functions.
14294     *
14295     * If an item changes (state of boolean changes, label or icons change),
14296     * then use elm_genlist_item_update() to have genlist update the item with
14297     * the new state. Genlist will re-realize the item thus call the functions
14298     * in the _Elm_Genlist_Item_Class for that item.
14299     *
14300     * To programmatically (un)select an item use elm_genlist_item_selected_set().
14301     * To get its selected state use elm_genlist_item_selected_get(). Similarly
14302     * to expand/contract an item and get its expanded state, use
14303     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14304     * again to make an item disabled (unable to be selected and appear
14305     * differently) use elm_genlist_item_disabled_set() to set this and
14306     * elm_genlist_item_disabled_get() to get the disabled state.
14307     *
14308     * In general to indicate how the genlist should expand items horizontally to
14309     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
14310     * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14311     * mode means that if items are too wide to fit, the scroller will scroll
14312     * horizontally. Otherwise items are expanded to fill the width of the
14313     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14314     * to the viewport width and limited to that size. This can be combined with
14315     * a different style that uses edjes' ellipsis feature (cutting text off like
14316     * this: "tex...").
14317     *
14318     * Items will only call their selection func and callback when first becoming
14319     * selected. Any further clicks will do nothing, unless you enable always
14320     * select with elm_genlist_always_select_mode_set(). This means even if
14321     * selected, every click will make the selected callbacks be called.
14322     * elm_genlist_no_select_mode_set() will turn off the ability to select
14323     * items entirely and they will neither appear selected nor call selected
14324     * callback functions.
14325     *
14326     * Remember that you can create new styles and add your own theme augmentation
14327     * per application with elm_theme_extension_add(). If you absolutely must
14328     * have a specific style that overrides any theme the user or system sets up
14329     * you can use elm_theme_overlay_add() to add such a file.
14330     *
14331     * @section Genlist_Implementation Implementation
14332     *
14333     * Evas tracks every object you create. Every time it processes an event
14334     * (mouse move, down, up etc.) it needs to walk through objects and find out
14335     * what event that affects. Even worse every time it renders display updates,
14336     * in order to just calculate what to re-draw, it needs to walk through many
14337     * many many objects. Thus, the more objects you keep active, the more
14338     * overhead Evas has in just doing its work. It is advisable to keep your
14339     * active objects to the minimum working set you need. Also remember that
14340     * object creation and deletion carries an overhead, so there is a
14341     * middle-ground, which is not easily determined. But don't keep massive lists
14342     * of objects you can't see or use. Genlist does this with list objects. It
14343     * creates and destroys them dynamically as you scroll around. It groups them
14344     * into blocks so it can determine the visibility etc. of a whole block at
14345     * once as opposed to having to walk the whole list. This 2-level list allows
14346     * for very large numbers of items to be in the list (tests have used up to
14347     * 2,000,000 items). Also genlist employs a queue for adding items. As items
14348     * may be different sizes, every item added needs to be calculated as to its
14349     * size and thus this presents a lot of overhead on populating the list, this
14350     * genlist employs a queue. Any item added is queued and spooled off over
14351     * time, actually appearing some time later, so if your list has many members
14352     * you may find it takes a while for them to all appear, with your process
14353     * consuming a lot of CPU while it is busy spooling.
14354     *
14355     * Genlist also implements a tree structure, but it does so with callbacks to
14356     * the application, with the application filling in tree structures when
14357     * requested (allowing for efficient building of a very deep tree that could
14358     * even be used for file-management). See the above smart signal callbacks for
14359     * details.
14360     *
14361     * @section Genlist_Smart_Events Genlist smart events
14362     *
14363     * Signals that you can add callbacks for are:
14364     * - @c "activated" - The user has double-clicked or pressed
14365     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
14366     *   item that was activated.
14367     * - @c "clicked,double" - The user has double-clicked an item.  The @c
14368     *   event_info parameter is the item that was double-clicked.
14369     * - @c "selected" - This is called when a user has made an item selected.
14370     *   The event_info parameter is the genlist item that was selected.
14371     * - @c "unselected" - This is called when a user has made an item
14372     *   unselected. The event_info parameter is the genlist item that was
14373     *   unselected.
14374     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14375     *   called and the item is now meant to be expanded. The event_info
14376     *   parameter is the genlist item that was indicated to expand.  It is the
14377     *   job of this callback to then fill in the child items.
14378     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14379     *   called and the item is now meant to be contracted. The event_info
14380     *   parameter is the genlist item that was indicated to contract. It is the
14381     *   job of this callback to then delete the child items.
14382     * - @c "expand,request" - This is called when a user has indicated they want
14383     *   to expand a tree branch item. The callback should decide if the item can
14384     *   expand (has any children) and then call elm_genlist_item_expanded_set()
14385     *   appropriately to set the state. The event_info parameter is the genlist
14386     *   item that was indicated to expand.
14387     * - @c "contract,request" - This is called when a user has indicated they
14388     *   want to contract a tree branch item. The callback should decide if the
14389     *   item can contract (has any children) and then call
14390     *   elm_genlist_item_expanded_set() appropriately to set the state. The
14391     *   event_info parameter is the genlist item that was indicated to contract.
14392     * - @c "realized" - This is called when the item in the list is created as a
14393     *   real evas object. event_info parameter is the genlist item that was
14394     *   created. The object may be deleted at any time, so it is up to the
14395     *   caller to not use the object pointer from elm_genlist_item_object_get()
14396     *   in a way where it may point to freed objects.
14397     * - @c "unrealized" - This is called just before an item is unrealized.
14398     *   After this call icon objects provided will be deleted and the item
14399     *   object itself delete or be put into a floating cache.
14400     * - @c "drag,start,up" - This is called when the item in the list has been
14401     *   dragged (not scrolled) up.
14402     * - @c "drag,start,down" - This is called when the item in the list has been
14403     *   dragged (not scrolled) down.
14404     * - @c "drag,start,left" - This is called when the item in the list has been
14405     *   dragged (not scrolled) left.
14406     * - @c "drag,start,right" - This is called when the item in the list has
14407     *   been dragged (not scrolled) right.
14408     * - @c "drag,stop" - This is called when the item in the list has stopped
14409     *   being dragged.
14410     * - @c "drag" - This is called when the item in the list is being dragged.
14411     * - @c "longpressed" - This is called when the item is pressed for a certain
14412     *   amount of time. By default it's 1 second.
14413     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14414     *   the top edge.
14415     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14416     *   until the bottom edge.
14417     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14418     *   until the left edge.
14419     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14420     *   until the right edge.
14421     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14422     *   swiped left.
14423     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14424     *   swiped right.
14425     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14426     *   swiped up.
14427     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14428     *   swiped down.
14429     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14430     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
14431     *   multi-touch pinched in.
14432     * - @c "swipe" - This is called when the genlist is swiped.
14433     *
14434     * @section Genlist_Examples Examples
14435     *
14436     * Here is a list of examples that use the genlist, trying to show some of
14437     * its capabilities:
14438     * - @ref genlist_example_01
14439     * - @ref genlist_example_02
14440     * - @ref genlist_example_03
14441     * - @ref genlist_example_04
14442     * - @ref genlist_example_05
14443     */
14444
14445    /**
14446     * @addtogroup Genlist
14447     * @{
14448     */
14449
14450    /**
14451     * @enum _Elm_Genlist_Item_Flags
14452     * @typedef Elm_Genlist_Item_Flags
14453     *
14454     * Defines if the item is of any special type (has subitems or it's the
14455     * index of a group), or is just a simple item.
14456     *
14457     * @ingroup Genlist
14458     */
14459    typedef enum _Elm_Genlist_Item_Flags
14460      {
14461         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14462         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14463         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14464      } Elm_Genlist_Item_Flags;
14465    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
14466    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14467    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14468    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14469    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14470    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14471    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14472    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
14473
14474    /**
14475     * @struct _Elm_Genlist_Item_Class
14476     *
14477     * Genlist item class definition structs.
14478     *
14479     * This struct contains the style and fetching functions that will define the
14480     * contents of each item.
14481     *
14482     * @see @ref Genlist_Item_Class
14483     */
14484    struct _Elm_Genlist_Item_Class
14485      {
14486         const char                *item_style; /**< style of this class. */
14487         struct
14488           {
14489              GenlistItemLabelGetFunc  label_get; /**< Label fetching class function for genlist item classes.*/
14490              GenlistItemIconGetFunc   icon_get; /**< Icon fetching class function for genlist item classes. */
14491              GenlistItemStateGetFunc  state_get; /**< State fetching class function for genlist item classes. */
14492              GenlistItemDelFunc       del; /**< Deletion class function for genlist item classes. */
14493              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
14494           } func;
14495         const char                *mode_item_style;
14496      };
14497
14498    /**
14499     * Add a new genlist widget to the given parent Elementary
14500     * (container) object
14501     *
14502     * @param parent The parent object
14503     * @return a new genlist widget handle or @c NULL, on errors
14504     *
14505     * This function inserts a new genlist widget on the canvas.
14506     *
14507     * @see elm_genlist_item_append()
14508     * @see elm_genlist_item_del()
14509     * @see elm_genlist_clear()
14510     *
14511     * @ingroup Genlist
14512     */
14513    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14514    /**
14515     * Remove all items from a given genlist widget.
14516     *
14517     * @param obj The genlist object
14518     *
14519     * This removes (and deletes) all items in @p obj, leaving it empty.
14520     *
14521     * @see elm_genlist_item_del(), to remove just one item.
14522     *
14523     * @ingroup Genlist
14524     */
14525    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14526    /**
14527     * Enable or disable multi-selection in the genlist
14528     *
14529     * @param obj The genlist object
14530     * @param multi Multi-select enable/disable. Default is disabled.
14531     *
14532     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14533     * the list. This allows more than 1 item to be selected. To retrieve the list
14534     * of selected items, use elm_genlist_selected_items_get().
14535     *
14536     * @see elm_genlist_selected_items_get()
14537     * @see elm_genlist_multi_select_get()
14538     *
14539     * @ingroup Genlist
14540     */
14541    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14542    /**
14543     * Gets if multi-selection in genlist is enabled or disabled.
14544     *
14545     * @param obj The genlist object
14546     * @return Multi-select enabled/disabled
14547     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14548     *
14549     * @see elm_genlist_multi_select_set()
14550     *
14551     * @ingroup Genlist
14552     */
14553    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14554    /**
14555     * This sets the horizontal stretching mode.
14556     *
14557     * @param obj The genlist object
14558     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14559     *
14560     * This sets the mode used for sizing items horizontally. Valid modes
14561     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14562     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14563     * the scroller will scroll horizontally. Otherwise items are expanded
14564     * to fill the width of the viewport of the scroller. If it is
14565     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14566     * limited to that size.
14567     *
14568     * @see elm_genlist_horizontal_get()
14569     *
14570     * @ingroup Genlist
14571     */
14572    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14573    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14574    /**
14575     * Gets the horizontal stretching mode.
14576     *
14577     * @param obj The genlist object
14578     * @return The mode to use
14579     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14580     *
14581     * @see elm_genlist_horizontal_set()
14582     *
14583     * @ingroup Genlist
14584     */
14585    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14586    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14587    /**
14588     * Set the always select mode.
14589     *
14590     * @param obj The genlist object
14591     * @param always_select The always select mode (@c EINA_TRUE = on, @c
14592     * EINA_FALSE = off). Default is @c EINA_FALSE.
14593     *
14594     * Items will only call their selection func and callback when first
14595     * becoming selected. Any further clicks will do nothing, unless you
14596     * enable always select with elm_genlist_always_select_mode_set().
14597     * This means that, even if selected, every click will make the selected
14598     * callbacks be called.
14599     *
14600     * @see elm_genlist_always_select_mode_get()
14601     *
14602     * @ingroup Genlist
14603     */
14604    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14605    /**
14606     * Get the always select mode.
14607     *
14608     * @param obj The genlist object
14609     * @return The always select mode
14610     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14611     *
14612     * @see elm_genlist_always_select_mode_set()
14613     *
14614     * @ingroup Genlist
14615     */
14616    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14617    /**
14618     * Enable/disable the no select mode.
14619     *
14620     * @param obj The genlist object
14621     * @param no_select The no select mode
14622     * (EINA_TRUE = on, EINA_FALSE = off)
14623     *
14624     * This will turn off the ability to select items entirely and they
14625     * will neither appear selected nor call selected callback functions.
14626     *
14627     * @see elm_genlist_no_select_mode_get()
14628     *
14629     * @ingroup Genlist
14630     */
14631    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14632    /**
14633     * Gets whether the no select mode is enabled.
14634     *
14635     * @param obj The genlist object
14636     * @return The no select mode
14637     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14638     *
14639     * @see elm_genlist_no_select_mode_set()
14640     *
14641     * @ingroup Genlist
14642     */
14643    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14644    /**
14645     * Enable/disable compress mode.
14646     *
14647     * @param obj The genlist object
14648     * @param compress The compress mode
14649     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14650     *
14651     * This will enable the compress mode where items are "compressed"
14652     * horizontally to fit the genlist scrollable viewport width. This is
14653     * special for genlist.  Do not rely on
14654     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
14655     * work as genlist needs to handle it specially.
14656     *
14657     * @see elm_genlist_compress_mode_get()
14658     *
14659     * @ingroup Genlist
14660     */
14661    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14662    /**
14663     * Get whether the compress mode is enabled.
14664     *
14665     * @param obj The genlist object
14666     * @return The compress mode
14667     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14668     *
14669     * @see elm_genlist_compress_mode_set()
14670     *
14671     * @ingroup Genlist
14672     */
14673    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14674    /**
14675     * Enable/disable height-for-width mode.
14676     *
14677     * @param obj The genlist object
14678     * @param setting The height-for-width mode (@c EINA_TRUE = on,
14679     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14680     *
14681     * With height-for-width mode the item width will be fixed (restricted
14682     * to a minimum of) to the list width when calculating its size in
14683     * order to allow the height to be calculated based on it. This allows,
14684     * for instance, text block to wrap lines if the Edje part is
14685     * configured with "text.min: 0 1".
14686     *
14687     * @note This mode will make list resize slower as it will have to
14688     *       recalculate every item height again whenever the list width
14689     *       changes!
14690     *
14691     * @note When height-for-width mode is enabled, it also enables
14692     *       compress mode (see elm_genlist_compress_mode_set()) and
14693     *       disables homogeneous (see elm_genlist_homogeneous_set()).
14694     *
14695     * @ingroup Genlist
14696     */
14697    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14698    /**
14699     * Get whether the height-for-width mode is enabled.
14700     *
14701     * @param obj The genlist object
14702     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14703     * off)
14704     *
14705     * @ingroup Genlist
14706     */
14707    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14708    /**
14709     * Enable/disable horizontal and vertical bouncing effect.
14710     *
14711     * @param obj The genlist object
14712     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14713     * EINA_FALSE = off). Default is @c EINA_FALSE.
14714     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14715     * EINA_FALSE = off). Default is @c EINA_TRUE.
14716     *
14717     * This will enable or disable the scroller bouncing effect for the
14718     * genlist. See elm_scroller_bounce_set() for details.
14719     *
14720     * @see elm_scroller_bounce_set()
14721     * @see elm_genlist_bounce_get()
14722     *
14723     * @ingroup Genlist
14724     */
14725    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14726    /**
14727     * Get whether the horizontal and vertical bouncing effect is enabled.
14728     *
14729     * @param obj The genlist object
14730     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14731     * option is set.
14732     * @param v_bounce Pointer to a bool to receive if the bounce vertically
14733     * option is set.
14734     *
14735     * @see elm_genlist_bounce_set()
14736     *
14737     * @ingroup Genlist
14738     */
14739    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14740    /**
14741     * Enable/disable homogenous mode.
14742     *
14743     * @param obj The genlist object
14744     * @param homogeneous Assume the items within the genlist are of the
14745     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14746     * EINA_FALSE.
14747     *
14748     * This will enable the homogeneous mode where items are of the same
14749     * height and width so that genlist may do the lazy-loading at its
14750     * maximum (which increases the performance for scrolling the list). This
14751     * implies 'compressed' mode.
14752     *
14753     * @see elm_genlist_compress_mode_set()
14754     * @see elm_genlist_homogeneous_get()
14755     *
14756     * @ingroup Genlist
14757     */
14758    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14759    /**
14760     * Get whether the homogenous mode is enabled.
14761     *
14762     * @param obj The genlist object
14763     * @return Assume the items within the genlist are of the same height
14764     * and width (EINA_TRUE = on, EINA_FALSE = off)
14765     *
14766     * @see elm_genlist_homogeneous_set()
14767     *
14768     * @ingroup Genlist
14769     */
14770    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14771    /**
14772     * Set the maximum number of items within an item block
14773     *
14774     * @param obj The genlist object
14775     * @param n   Maximum number of items within an item block. Default is 32.
14776     *
14777     * This will configure the block count to tune to the target with
14778     * particular performance matrix.
14779     *
14780     * A block of objects will be used to reduce the number of operations due to
14781     * many objects in the screen. It can determine the visibility, or if the
14782     * object has changed, it theme needs to be updated, etc. doing this kind of
14783     * calculation to the entire block, instead of per object.
14784     *
14785     * The default value for the block count is enough for most lists, so unless
14786     * you know you will have a lot of objects visible in the screen at the same
14787     * time, don't try to change this.
14788     *
14789     * @see elm_genlist_block_count_get()
14790     * @see @ref Genlist_Implementation
14791     *
14792     * @ingroup Genlist
14793     */
14794    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
14795    /**
14796     * Get the maximum number of items within an item block
14797     *
14798     * @param obj The genlist object
14799     * @return Maximum number of items within an item block
14800     *
14801     * @see elm_genlist_block_count_set()
14802     *
14803     * @ingroup Genlist
14804     */
14805    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14806    /**
14807     * Set the timeout in seconds for the longpress event.
14808     *
14809     * @param obj The genlist object
14810     * @param timeout timeout in seconds. Default is 1.
14811     *
14812     * This option will change how long it takes to send an event "longpressed"
14813     * after the mouse down signal is sent to the list. If this event occurs, no
14814     * "clicked" event will be sent.
14815     *
14816     * @see elm_genlist_longpress_timeout_set()
14817     *
14818     * @ingroup Genlist
14819     */
14820    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
14821    /**
14822     * Get the timeout in seconds for the longpress event.
14823     *
14824     * @param obj The genlist object
14825     * @return timeout in seconds
14826     *
14827     * @see elm_genlist_longpress_timeout_get()
14828     *
14829     * @ingroup Genlist
14830     */
14831    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14832    /**
14833     * Append a new item in a given genlist widget.
14834     *
14835     * @param obj The genlist object
14836     * @param itc The item class for the item
14837     * @param data The item data
14838     * @param parent The parent item, or NULL if none
14839     * @param flags Item flags
14840     * @param func Convenience function called when the item is selected
14841     * @param func_data Data passed to @p func above.
14842     * @return A handle to the item added or @c NULL if not possible
14843     *
14844     * This adds the given item to the end of the list or the end of
14845     * the children list if the @p parent is given.
14846     *
14847     * @see elm_genlist_item_prepend()
14848     * @see elm_genlist_item_insert_before()
14849     * @see elm_genlist_item_insert_after()
14850     * @see elm_genlist_item_del()
14851     *
14852     * @ingroup Genlist
14853     */
14854    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);
14855    /**
14856     * Prepend a new item in a given genlist widget.
14857     *
14858     * @param obj The genlist object
14859     * @param itc The item class for the item
14860     * @param data The item data
14861     * @param parent The parent item, or NULL if none
14862     * @param flags Item flags
14863     * @param func Convenience function called when the item is selected
14864     * @param func_data Data passed to @p func above.
14865     * @return A handle to the item added or NULL if not possible
14866     *
14867     * This adds an item to the beginning of the list or beginning of the
14868     * children of the parent if given.
14869     *
14870     * @see elm_genlist_item_append()
14871     * @see elm_genlist_item_insert_before()
14872     * @see elm_genlist_item_insert_after()
14873     * @see elm_genlist_item_del()
14874     *
14875     * @ingroup Genlist
14876     */
14877    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);
14878    /**
14879     * Insert an item before another in a genlist widget
14880     *
14881     * @param obj The genlist object
14882     * @param itc The item class for the item
14883     * @param data The item data
14884     * @param before The item to place this new one before.
14885     * @param flags Item flags
14886     * @param func Convenience function called when the item is selected
14887     * @param func_data Data passed to @p func above.
14888     * @return A handle to the item added or @c NULL if not possible
14889     *
14890     * This inserts an item before another in the list. It will be in the
14891     * same tree level or group as the item it is inserted before.
14892     *
14893     * @see elm_genlist_item_append()
14894     * @see elm_genlist_item_prepend()
14895     * @see elm_genlist_item_insert_after()
14896     * @see elm_genlist_item_del()
14897     *
14898     * @ingroup Genlist
14899     */
14900    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);
14901    /**
14902     * Insert an item after another in a genlist widget
14903     *
14904     * @param obj The genlist object
14905     * @param itc The item class for the item
14906     * @param data The item data
14907     * @param after The item to place this new one after.
14908     * @param flags Item flags
14909     * @param func Convenience function called when the item is selected
14910     * @param func_data Data passed to @p func above.
14911     * @return A handle to the item added or @c NULL if not possible
14912     *
14913     * This inserts an item after another in the list. It will be in the
14914     * same tree level or group as the item it is inserted after.
14915     *
14916     * @see elm_genlist_item_append()
14917     * @see elm_genlist_item_prepend()
14918     * @see elm_genlist_item_insert_before()
14919     * @see elm_genlist_item_del()
14920     *
14921     * @ingroup Genlist
14922     */
14923    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);
14924    /**
14925     * Insert a new item into the sorted genlist object
14926     *
14927     * @param obj The genlist object
14928     * @param itc The item class for the item
14929     * @param data The item data
14930     * @param parent The parent item, or NULL if none
14931     * @param flags Item flags
14932     * @param comp The function called for the sort
14933     * @param func Convenience function called when item selected
14934     * @param func_data Data passed to @p func above.
14935     * @return A handle to the item added or NULL if not possible
14936     *
14937     * @ingroup Genlist
14938     */
14939    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);
14940    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);
14941    /* operations to retrieve existing items */
14942    /**
14943     * Get the selectd item in the genlist.
14944     *
14945     * @param obj The genlist object
14946     * @return The selected item, or NULL if none is selected.
14947     *
14948     * This gets the selected item in the list (if multi-selection is enabled, only
14949     * the item that was first selected in the list is returned - which is not very
14950     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
14951     * used).
14952     *
14953     * If no item is selected, NULL is returned.
14954     *
14955     * @see elm_genlist_selected_items_get()
14956     *
14957     * @ingroup Genlist
14958     */
14959    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14960    /**
14961     * Get a list of selected items in the genlist.
14962     *
14963     * @param obj The genlist object
14964     * @return The list of selected items, or NULL if none are selected.
14965     *
14966     * It returns a list of the selected items. This list pointer is only valid so
14967     * long as the selection doesn't change (no items are selected or unselected, or
14968     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
14969     * pointers. The order of the items in this list is the order which they were
14970     * selected, i.e. the first item in this list is the first item that was
14971     * selected, and so on.
14972     *
14973     * @note If not in multi-select mode, consider using function
14974     * elm_genlist_selected_item_get() instead.
14975     *
14976     * @see elm_genlist_multi_select_set()
14977     * @see elm_genlist_selected_item_get()
14978     *
14979     * @ingroup Genlist
14980     */
14981    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14982    /**
14983     * Get a list of realized items in genlist
14984     *
14985     * @param obj The genlist object
14986     * @return The list of realized items, nor NULL if none are realized.
14987     *
14988     * This returns a list of the realized items in the genlist. The list
14989     * contains Elm_Genlist_Item pointers. The list must be freed by the
14990     * caller when done with eina_list_free(). The item pointers in the
14991     * list are only valid so long as those items are not deleted or the
14992     * genlist is not deleted.
14993     *
14994     * @see elm_genlist_realized_items_update()
14995     *
14996     * @ingroup Genlist
14997     */
14998    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14999    /**
15000     * Get the item that is at the x, y canvas coords.
15001     *
15002     * @param obj The gelinst object.
15003     * @param x The input x coordinate
15004     * @param y The input y coordinate
15005     * @param posret The position relative to the item returned here
15006     * @return The item at the coordinates or NULL if none
15007     *
15008     * This returns the item at the given coordinates (which are canvas
15009     * relative, not object-relative). If an item is at that coordinate,
15010     * that item handle is returned, and if @p posret is not NULL, the
15011     * integer pointed to is set to a value of -1, 0 or 1, depending if
15012     * the coordinate is on the upper portion of that item (-1), on the
15013     * middle section (0) or on the lower part (1). If NULL is returned as
15014     * an item (no item found there), then posret may indicate -1 or 1
15015     * based if the coordinate is above or below all items respectively in
15016     * the genlist.
15017     *
15018     * @ingroup Genlist
15019     */
15020    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);
15021    /**
15022     * Get the first item in the genlist
15023     *
15024     * This returns the first item in the list.
15025     *
15026     * @param obj The genlist object
15027     * @return The first item, or NULL if none
15028     *
15029     * @ingroup Genlist
15030     */
15031    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15032    /**
15033     * Get the last item in the genlist
15034     *
15035     * This returns the last item in the list.
15036     *
15037     * @return The last item, or NULL if none
15038     *
15039     * @ingroup Genlist
15040     */
15041    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15042    /**
15043     * Set the scrollbar policy
15044     *
15045     * @param obj The genlist object
15046     * @param policy_h Horizontal scrollbar policy.
15047     * @param policy_v Vertical scrollbar policy.
15048     *
15049     * This sets the scrollbar visibility policy for the given genlist
15050     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15051     * made visible if it is needed, and otherwise kept hidden.
15052     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15053     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15054     * respectively for the horizontal and vertical scrollbars. Default is
15055     * #ELM_SMART_SCROLLER_POLICY_AUTO
15056     *
15057     * @see elm_genlist_scroller_policy_get()
15058     *
15059     * @ingroup Genlist
15060     */
15061    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15062    /**
15063     * Get the scrollbar policy
15064     *
15065     * @param obj The genlist object
15066     * @param policy_h Pointer to store the horizontal scrollbar policy.
15067     * @param policy_v Pointer to store the vertical scrollbar policy.
15068     *
15069     * @see elm_genlist_scroller_policy_set()
15070     *
15071     * @ingroup Genlist
15072     */
15073    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);
15074    /**
15075     * Get the @b next item in a genlist widget's internal list of items,
15076     * given a handle to one of those items.
15077     *
15078     * @param item The genlist item to fetch next from
15079     * @return The item after @p item, or @c NULL if there's none (and
15080     * on errors)
15081     *
15082     * This returns the item placed after the @p item, on the container
15083     * genlist.
15084     *
15085     * @see elm_genlist_item_prev_get()
15086     *
15087     * @ingroup Genlist
15088     */
15089    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15090    /**
15091     * Get the @b previous item in a genlist widget's internal list of items,
15092     * given a handle to one of those items.
15093     *
15094     * @param item The genlist item to fetch previous from
15095     * @return The item before @p item, or @c NULL if there's none (and
15096     * on errors)
15097     *
15098     * This returns the item placed before the @p item, on the container
15099     * genlist.
15100     *
15101     * @see elm_genlist_item_next_get()
15102     *
15103     * @ingroup Genlist
15104     */
15105    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15106    /**
15107     * Get the genlist object's handle which contains a given genlist
15108     * item
15109     *
15110     * @param item The item to fetch the container from
15111     * @return The genlist (parent) object
15112     *
15113     * This returns the genlist object itself that an item belongs to.
15114     *
15115     * @ingroup Genlist
15116     */
15117    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15118    /**
15119     * Get the parent item of the given item
15120     *
15121     * @param it The item
15122     * @return The parent of the item or @c NULL if it has no parent.
15123     *
15124     * This returns the item that was specified as parent of the item @p it on
15125     * elm_genlist_item_append() and insertion related functions.
15126     *
15127     * @ingroup Genlist
15128     */
15129    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15130    /**
15131     * Remove all sub-items (children) of the given item
15132     *
15133     * @param it The item
15134     *
15135     * This removes all items that are children (and their descendants) of the
15136     * given item @p it.
15137     *
15138     * @see elm_genlist_clear()
15139     * @see elm_genlist_item_del()
15140     *
15141     * @ingroup Genlist
15142     */
15143    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15144    /**
15145     * Set whether a given genlist item is selected or not
15146     *
15147     * @param it The item
15148     * @param selected Use @c EINA_TRUE, to make it selected, @c
15149     * EINA_FALSE to make it unselected
15150     *
15151     * This sets the selected state of an item. If multi selection is
15152     * not enabled on the containing genlist and @p selected is @c
15153     * EINA_TRUE, any other previously selected items will get
15154     * unselected in favor of this new one.
15155     *
15156     * @see elm_genlist_item_selected_get()
15157     *
15158     * @ingroup Genlist
15159     */
15160    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15161    /**
15162     * Get whether a given genlist item is selected or not
15163     *
15164     * @param it The item
15165     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15166     *
15167     * @see elm_genlist_item_selected_set() for more details
15168     *
15169     * @ingroup Genlist
15170     */
15171    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15172    /**
15173     * Sets the expanded state of an item.
15174     *
15175     * @param it The item
15176     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15177     *
15178     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15179     * expanded or not.
15180     *
15181     * The theme will respond to this change visually, and a signal "expanded" or
15182     * "contracted" will be sent from the genlist with a pointer to the item that
15183     * has been expanded/contracted.
15184     *
15185     * Calling this function won't show or hide any child of this item (if it is
15186     * a parent). You must manually delete and create them on the callbacks fo
15187     * the "expanded" or "contracted" signals.
15188     *
15189     * @see elm_genlist_item_expanded_get()
15190     *
15191     * @ingroup Genlist
15192     */
15193    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15194    /**
15195     * Get the expanded state of an item
15196     *
15197     * @param it The item
15198     * @return The expanded state
15199     *
15200     * This gets the expanded state of an item.
15201     *
15202     * @see elm_genlist_item_expanded_set()
15203     *
15204     * @ingroup Genlist
15205     */
15206    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15207    /**
15208     * Get the depth of expanded item
15209     *
15210     * @param it The genlist item object
15211     * @return The depth of expanded item
15212     *
15213     * @ingroup Genlist
15214     */
15215    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15216    /**
15217     * Set whether a given genlist item is disabled or not.
15218     *
15219     * @param it The item
15220     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15221     * to enable it back.
15222     *
15223     * A disabled item cannot be selected or unselected. It will also
15224     * change its appearance, to signal the user it's disabled.
15225     *
15226     * @see elm_genlist_item_disabled_get()
15227     *
15228     * @ingroup Genlist
15229     */
15230    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15231    /**
15232     * Get whether a given genlist item is disabled or not.
15233     *
15234     * @param it The item
15235     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15236     * (and on errors).
15237     *
15238     * @see elm_genlist_item_disabled_set() for more details
15239     *
15240     * @ingroup Genlist
15241     */
15242    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15243    /**
15244     * Sets the display only state of an item.
15245     *
15246     * @param it The item
15247     * @param display_only @c EINA_TRUE if the item is display only, @c
15248     * EINA_FALSE otherwise.
15249     *
15250     * A display only item cannot be selected or unselected. It is for
15251     * display only and not selecting or otherwise clicking, dragging
15252     * etc. by the user, thus finger size rules will not be applied to
15253     * this item.
15254     *
15255     * It's good to set group index items to display only state.
15256     *
15257     * @see elm_genlist_item_display_only_get()
15258     *
15259     * @ingroup Genlist
15260     */
15261    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15262    /**
15263     * Get the display only state of an item
15264     *
15265     * @param it The item
15266     * @return @c EINA_TRUE if the item is display only, @c
15267     * EINA_FALSE otherwise.
15268     *
15269     * @see elm_genlist_item_display_only_set()
15270     *
15271     * @ingroup Genlist
15272     */
15273    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) 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     * @see elm_genlist_item_bring_in()
15284     * @see elm_genlist_item_top_show()
15285     * @see elm_genlist_item_middle_show()
15286     *
15287     * @ingroup Genlist
15288     */
15289    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15290    /**
15291     * Animatedly bring in, to the visible are of a genlist, a given
15292     * item on it.
15293     *
15294     * @param it The item to display
15295     *
15296     * This causes genlist to jump to the given item @p it and show it (by
15297     * animatedly scrolling), if it is not fully visible. This may use animation
15298     * to do so and take a period of time
15299     *
15300     * @see elm_genlist_item_show()
15301     * @see elm_genlist_item_top_bring_in()
15302     * @see elm_genlist_item_middle_bring_in()
15303     *
15304     * @ingroup Genlist
15305     */
15306    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15307    /**
15308     * Show the portion of a genlist's internal list containing a given
15309     * item, immediately.
15310     *
15311     * @param it The item to display
15312     *
15313     * This causes genlist to jump to the given item @p it and show it (by
15314     * immediately scrolling to that position), if it is not fully visible.
15315     *
15316     * The item will be positioned at the top of the genlist viewport.
15317     *
15318     * @see elm_genlist_item_show()
15319     * @see elm_genlist_item_top_bring_in()
15320     *
15321     * @ingroup Genlist
15322     */
15323    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15324    /**
15325     * Animatedly bring in, to the visible are of a genlist, a given
15326     * item on it.
15327     *
15328     * @param it The item
15329     *
15330     * This causes genlist to jump to the given item @p it and show it (by
15331     * animatedly scrolling), if it is not fully visible. This may use animation
15332     * to do so and take a period of time
15333     *
15334     * The item will be positioned at the top of the genlist viewport.
15335     *
15336     * @see elm_genlist_item_bring_in()
15337     * @see elm_genlist_item_top_show()
15338     *
15339     * @ingroup Genlist
15340     */
15341    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15342    /**
15343     * Show the portion of a genlist's internal list containing a given
15344     * item, immediately.
15345     *
15346     * @param it The item to display
15347     *
15348     * This causes genlist to jump to the given item @p it and show it (by
15349     * immediately scrolling to that position), if it is not fully visible.
15350     *
15351     * The item will be positioned at the middle of the genlist viewport.
15352     *
15353     * @see elm_genlist_item_show()
15354     * @see elm_genlist_item_middle_bring_in()
15355     *
15356     * @ingroup Genlist
15357     */
15358    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15359    /**
15360     * Animatedly bring in, to the visible are of a genlist, a given
15361     * item on it.
15362     *
15363     * @param it The item
15364     *
15365     * This causes genlist to jump to the given item @p it and show it (by
15366     * animatedly scrolling), if it is not fully visible. This may use animation
15367     * to do so and take a period of time
15368     *
15369     * The item will be positioned at the middle of the genlist viewport.
15370     *
15371     * @see elm_genlist_item_bring_in()
15372     * @see elm_genlist_item_middle_show()
15373     *
15374     * @ingroup Genlist
15375     */
15376    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15377    /**
15378     * Remove a genlist item from the its parent, deleting it.
15379     *
15380     * @param item The item to be removed.
15381     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15382     *
15383     * @see elm_genlist_clear(), to remove all items in a genlist at
15384     * once.
15385     *
15386     * @ingroup Genlist
15387     */
15388    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15389    /**
15390     * Return the data associated to a given genlist item
15391     *
15392     * @param item The genlist item.
15393     * @return the data associated to this item.
15394     *
15395     * This returns the @c data value passed on the
15396     * elm_genlist_item_append() and related item addition calls.
15397     *
15398     * @see elm_genlist_item_append()
15399     * @see elm_genlist_item_data_set()
15400     *
15401     * @ingroup Genlist
15402     */
15403    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15404    /**
15405     * Set the data associated to a given genlist item
15406     *
15407     * @param item The genlist item
15408     * @param data The new data pointer to set on it
15409     *
15410     * This @b overrides the @c data value passed on the
15411     * elm_genlist_item_append() and related item addition calls. This
15412     * function @b won't call elm_genlist_item_update() automatically,
15413     * so you'd issue it afterwards if you want to hove the item
15414     * updated to reflect the that new data.
15415     *
15416     * @see elm_genlist_item_data_get()
15417     *
15418     * @ingroup Genlist
15419     */
15420    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15421    /**
15422     * Tells genlist to "orphan" icons fetchs by the item class
15423     *
15424     * @param it The item
15425     *
15426     * This instructs genlist to release references to icons in the item,
15427     * meaning that they will no longer be managed by genlist and are
15428     * floating "orphans" that can be re-used elsewhere if the user wants
15429     * to.
15430     *
15431     * @ingroup Genlist
15432     */
15433    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15434    /**
15435     * Get the real Evas object created to implement the view of a
15436     * given genlist item
15437     *
15438     * @param item The genlist item.
15439     * @return the Evas object implementing this item's view.
15440     *
15441     * This returns the actual Evas object used to implement the
15442     * specified genlist item's view. This may be @c NULL, as it may
15443     * not have been created or may have been deleted, at any time, by
15444     * the genlist. <b>Do not modify this object</b> (move, resize,
15445     * show, hide, etc.), as the genlist is controlling it. This
15446     * function is for querying, emitting custom signals or hooking
15447     * lower level callbacks for events on that object. Do not delete
15448     * this object under any circumstances.
15449     *
15450     * @see elm_genlist_item_data_get()
15451     *
15452     * @ingroup Genlist
15453     */
15454    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15455    /**
15456     * Update the contents of an item
15457     *
15458     * @param it The item
15459     *
15460     * This updates an item by calling all the item class functions again
15461     * to get the icons, labels and states. Use this when the original
15462     * item data has changed and the changes are desired to be reflected.
15463     *
15464     * Use elm_genlist_realized_items_update() to update all already realized
15465     * items.
15466     *
15467     * @see elm_genlist_realized_items_update()
15468     *
15469     * @ingroup Genlist
15470     */
15471    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15472    /**
15473     * Update the item class of an item
15474     *
15475     * @param it The item
15476     * @param itc The item class for the item
15477     *
15478     * This sets another class fo the item, changing the way that it is
15479     * displayed. After changing the item class, elm_genlist_item_update() is
15480     * called on the item @p it.
15481     *
15482     * @ingroup Genlist
15483     */
15484    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15485    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15486    /**
15487     * Set the text to be shown in a given genlist item's tooltips.
15488     *
15489     * @param item The genlist item
15490     * @param text The text to set in the content
15491     *
15492     * This call will setup the text to be used as tooltip to that item
15493     * (analogous to elm_object_tooltip_text_set(), but being item
15494     * tooltips with higher precedence than object tooltips). It can
15495     * have only one tooltip at a time, so any previous tooltip data
15496     * will get removed.
15497     *
15498     * In order to set an icon or something else as a tooltip, look at
15499     * elm_genlist_item_tooltip_content_cb_set().
15500     *
15501     * @ingroup Genlist
15502     */
15503    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15504    /**
15505     * Set the content to be shown in a given genlist item's tooltips
15506     *
15507     * @param item The genlist item.
15508     * @param func The function returning the tooltip contents.
15509     * @param data What to provide to @a func as callback data/context.
15510     * @param del_cb Called when data is not needed anymore, either when
15511     *        another callback replaces @p func, the tooltip is unset with
15512     *        elm_genlist_item_tooltip_unset() or the owner @p item
15513     *        dies. This callback receives as its first parameter the
15514     *        given @p data, being @c event_info the item handle.
15515     *
15516     * This call will setup the tooltip's contents to @p item
15517     * (analogous to elm_object_tooltip_content_cb_set(), but being
15518     * item tooltips with higher precedence than object tooltips). It
15519     * can have only one tooltip at a time, so any previous tooltip
15520     * content will get removed. @p func (with @p data) will be called
15521     * every time Elementary needs to show the tooltip and it should
15522     * return a valid Evas object, which will be fully managed by the
15523     * tooltip system, getting deleted when the tooltip is gone.
15524     *
15525     * In order to set just a text as a tooltip, look at
15526     * elm_genlist_item_tooltip_text_set().
15527     *
15528     * @ingroup Genlist
15529     */
15530    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);
15531    /**
15532     * Unset a tooltip from a given genlist item
15533     *
15534     * @param item genlist item to remove a previously set tooltip from.
15535     *
15536     * This call removes any tooltip set on @p item. The callback
15537     * provided as @c del_cb to
15538     * elm_genlist_item_tooltip_content_cb_set() will be called to
15539     * notify it is not used anymore (and have resources cleaned, if
15540     * need be).
15541     *
15542     * @see elm_genlist_item_tooltip_content_cb_set()
15543     *
15544     * @ingroup Genlist
15545     */
15546    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15547    /**
15548     * Set a different @b style for a given genlist item's tooltip.
15549     *
15550     * @param item genlist item with tooltip set
15551     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15552     * "default", @c "transparent", etc)
15553     *
15554     * Tooltips can have <b>alternate styles</b> to be displayed on,
15555     * which are defined by the theme set on Elementary. This function
15556     * works analogously as elm_object_tooltip_style_set(), but here
15557     * applied only to genlist item objects. The default style for
15558     * tooltips is @c "default".
15559     *
15560     * @note before you set a style you should define a tooltip with
15561     *       elm_genlist_item_tooltip_content_cb_set() or
15562     *       elm_genlist_item_tooltip_text_set()
15563     *
15564     * @see elm_genlist_item_tooltip_style_get()
15565     *
15566     * @ingroup Genlist
15567     */
15568    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15569    /**
15570     * Get the style set a given genlist item's tooltip.
15571     *
15572     * @param item genlist item with tooltip already set on.
15573     * @return style the theme style in use, which defaults to
15574     *         "default". If the object does not have a tooltip set,
15575     *         then @c NULL is returned.
15576     *
15577     * @see elm_genlist_item_tooltip_style_set() for more details
15578     *
15579     * @ingroup Genlist
15580     */
15581    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15582    /**
15583     * @brief Disable size restrictions on an object's tooltip
15584     * @param item The tooltip's anchor object
15585     * @param disable If EINA_TRUE, size restrictions are disabled
15586     * @return EINA_FALSE on failure, EINA_TRUE on success
15587     *
15588     * This function allows a tooltip to expand beyond its parant window's canvas.
15589     * It will instead be limited only by the size of the display.
15590     */
15591    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15592    /**
15593     * @brief Retrieve size restriction state of an object's tooltip
15594     * @param item The tooltip's anchor object
15595     * @return If EINA_TRUE, size restrictions are disabled
15596     *
15597     * This function returns whether a tooltip is allowed to expand beyond
15598     * its parant window's canvas.
15599     * It will instead be limited only by the size of the display.
15600     */
15601    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15602    /**
15603     * Set the type of mouse pointer/cursor decoration to be shown,
15604     * when the mouse pointer is over the given genlist widget item
15605     *
15606     * @param item genlist item to customize cursor on
15607     * @param cursor the cursor type's name
15608     *
15609     * This function works analogously as elm_object_cursor_set(), but
15610     * here the cursor's changing area is restricted to the item's
15611     * area, and not the whole widget's. Note that that item cursors
15612     * have precedence over widget cursors, so that a mouse over @p
15613     * item will always show cursor @p type.
15614     *
15615     * If this function is called twice for an object, a previously set
15616     * cursor will be unset on the second call.
15617     *
15618     * @see elm_object_cursor_set()
15619     * @see elm_genlist_item_cursor_get()
15620     * @see elm_genlist_item_cursor_unset()
15621     *
15622     * @ingroup Genlist
15623     */
15624    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15625    /**
15626     * Get the type of mouse pointer/cursor decoration set to be shown,
15627     * when the mouse pointer is over the given genlist widget item
15628     *
15629     * @param item genlist item with custom cursor set
15630     * @return the cursor type's name or @c NULL, if no custom cursors
15631     * were set to @p item (and on errors)
15632     *
15633     * @see elm_object_cursor_get()
15634     * @see elm_genlist_item_cursor_set() for more details
15635     * @see elm_genlist_item_cursor_unset()
15636     *
15637     * @ingroup Genlist
15638     */
15639    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15640    /**
15641     * Unset any custom mouse pointer/cursor decoration set to be
15642     * shown, when the mouse pointer is over the given genlist widget
15643     * item, thus making it show the @b default cursor again.
15644     *
15645     * @param item a genlist item
15646     *
15647     * Use this call to undo any custom settings on this item's cursor
15648     * decoration, bringing it back to defaults (no custom style set).
15649     *
15650     * @see elm_object_cursor_unset()
15651     * @see elm_genlist_item_cursor_set() for more details
15652     *
15653     * @ingroup Genlist
15654     */
15655    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15656    /**
15657     * Set a different @b style for a given custom cursor set for a
15658     * genlist item.
15659     *
15660     * @param item genlist item with custom cursor set
15661     * @param style the <b>theme style</b> to use (e.g. @c "default",
15662     * @c "transparent", etc)
15663     *
15664     * This function only makes sense when one is using custom mouse
15665     * cursor decorations <b>defined in a theme file</b> , which can
15666     * have, given a cursor name/type, <b>alternate styles</b> on
15667     * it. It works analogously as elm_object_cursor_style_set(), but
15668     * here applied only to genlist item objects.
15669     *
15670     * @warning Before you set a cursor style you should have defined a
15671     *       custom cursor previously on the item, with
15672     *       elm_genlist_item_cursor_set()
15673     *
15674     * @see elm_genlist_item_cursor_engine_only_set()
15675     * @see elm_genlist_item_cursor_style_get()
15676     *
15677     * @ingroup Genlist
15678     */
15679    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15680    /**
15681     * Get the current @b style set for a given genlist item's custom
15682     * cursor
15683     *
15684     * @param item genlist item with custom cursor set.
15685     * @return style the cursor style in use. If the object does not
15686     *         have a cursor set, then @c NULL is returned.
15687     *
15688     * @see elm_genlist_item_cursor_style_set() for more details
15689     *
15690     * @ingroup Genlist
15691     */
15692    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15693    /**
15694     * Set if the (custom) cursor for a given genlist item should be
15695     * searched in its theme, also, or should only rely on the
15696     * rendering engine.
15697     *
15698     * @param item item with custom (custom) cursor already set on
15699     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15700     * only on those provided by the rendering engine, @c EINA_FALSE to
15701     * have them searched on the widget's theme, as well.
15702     *
15703     * @note This call is of use only if you've set a custom cursor
15704     * for genlist items, with elm_genlist_item_cursor_set().
15705     *
15706     * @note By default, cursors will only be looked for between those
15707     * provided by the rendering engine.
15708     *
15709     * @ingroup Genlist
15710     */
15711    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15712    /**
15713     * Get if the (custom) cursor for a given genlist item is being
15714     * searched in its theme, also, or is only relying on the rendering
15715     * engine.
15716     *
15717     * @param item a genlist item
15718     * @return @c EINA_TRUE, if cursors are being looked for only on
15719     * those provided by the rendering engine, @c EINA_FALSE if they
15720     * are being searched on the widget's theme, as well.
15721     *
15722     * @see elm_genlist_item_cursor_engine_only_set(), for more details
15723     *
15724     * @ingroup Genlist
15725     */
15726    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15727    /**
15728     * Update the contents of all realized items.
15729     *
15730     * @param obj The genlist object.
15731     *
15732     * This updates all realized items by calling all the item class functions again
15733     * to get the icons, labels and states. Use this when the original
15734     * item data has changed and the changes are desired to be reflected.
15735     *
15736     * To update just one item, use elm_genlist_item_update().
15737     *
15738     * @see elm_genlist_realized_items_get()
15739     * @see elm_genlist_item_update()
15740     *
15741     * @ingroup Genlist
15742     */
15743    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15744    /**
15745     * Activate a genlist mode on an item
15746     *
15747     * @param item The genlist item
15748     * @param mode Mode name
15749     * @param mode_set Boolean to define set or unset mode.
15750     *
15751     * A genlist mode is a different way of selecting an item. Once a mode is
15752     * activated on an item, any other selected item is immediately unselected.
15753     * This feature provides an easy way of implementing a new kind of animation
15754     * for selecting an item, without having to entirely rewrite the item style
15755     * theme. However, the elm_genlist_selected_* API can't be used to get what
15756     * item is activate for a mode.
15757     *
15758     * The current item style will still be used, but applying a genlist mode to
15759     * an item will select it using a different kind of animation.
15760     *
15761     * The current active item for a mode can be found by
15762     * elm_genlist_mode_item_get().
15763     *
15764     * The characteristics of genlist mode are:
15765     * - Only one mode can be active at any time, and for only one item.
15766     * - Genlist handles deactivating other items when one item is activated.
15767     * - A mode is defined in the genlist theme (edc), and more modes can easily
15768     *   be added.
15769     * - A mode style and the genlist item style are different things. They
15770     *   can be combined to provide a default style to the item, with some kind
15771     *   of animation for that item when the mode is activated.
15772     *
15773     * When a mode is activated on an item, a new view for that item is created.
15774     * The theme of this mode defines the animation that will be used to transit
15775     * the item from the old view to the new view. This second (new) view will be
15776     * active for that item while the mode is active on the item, and will be
15777     * destroyed after the mode is totally deactivated from that item.
15778     *
15779     * @see elm_genlist_mode_get()
15780     * @see elm_genlist_mode_item_get()
15781     *
15782     * @ingroup Genlist
15783     */
15784    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
15785    /**
15786     * Get the last (or current) genlist mode used.
15787     *
15788     * @param obj The genlist object
15789     *
15790     * This function just returns the name of the last used genlist mode. It will
15791     * be the current mode if it's still active.
15792     *
15793     * @see elm_genlist_item_mode_set()
15794     * @see elm_genlist_mode_item_get()
15795     *
15796     * @ingroup Genlist
15797     */
15798    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15799    /**
15800     * Get active genlist mode item
15801     *
15802     * @param obj The genlist object
15803     * @return The active item for that current mode. Or @c NULL if no item is
15804     * activated with any mode.
15805     *
15806     * This function returns the item that was activated with a mode, by the
15807     * function elm_genlist_item_mode_set().
15808     *
15809     * @see elm_genlist_item_mode_set()
15810     * @see elm_genlist_mode_get()
15811     *
15812     * @ingroup Genlist
15813     */
15814    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15815    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
15816    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15817
15818    /**
15819     * @}
15820     */
15821
15822    /**
15823     * @defgroup Check Check
15824     *
15825     * @image html img/widget/check/preview-00.png
15826     * @image latex img/widget/check/preview-00.eps
15827     * @image html img/widget/check/preview-01.png
15828     * @image latex img/widget/check/preview-01.eps
15829     * @image html img/widget/check/preview-02.png
15830     * @image latex img/widget/check/preview-02.eps
15831     *
15832     * @brief The check widget allows for toggling a value between true and
15833     * false.
15834     *
15835     * Check objects are a lot like radio objects in layout and functionality
15836     * except they do not work as a group, but independently and only toggle the
15837     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
15838     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
15839     * returns the current state. For convenience, like the radio objects, you
15840     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
15841     * for it to modify.
15842     *
15843     * Signals that you can add callbacks for are:
15844     * "changed" - This is called whenever the user changes the state of one of
15845     *             the check object(event_info is NULL).
15846     *
15847     * @ref tutorial_check should give you a firm grasp of how to use this widget.
15848     * @{
15849     */
15850    /**
15851     * @brief Add a new Check object
15852     *
15853     * @param parent The parent object
15854     * @return The new object or NULL if it cannot be created
15855     */
15856    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15857    /**
15858     * @brief Set the text label of the check object
15859     *
15860     * @param obj The check object
15861     * @param label The text label string in UTF-8
15862     *
15863     * @deprecated use elm_object_text_set() instead.
15864     */
15865    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15866    /**
15867     * @brief Get the text label of the check object
15868     *
15869     * @param obj The check object
15870     * @return The text label string in UTF-8
15871     *
15872     * @deprecated use elm_object_text_get() instead.
15873     */
15874    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15875    /**
15876     * @brief Set the icon object of the check object
15877     *
15878     * @param obj The check object
15879     * @param icon The icon object
15880     *
15881     * Once the icon object is set, a previously set one will be deleted.
15882     * If you want to keep that old content object, use the
15883     * elm_check_icon_unset() function.
15884     */
15885    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15886    /**
15887     * @brief Get the icon object of the check object
15888     *
15889     * @param obj The check object
15890     * @return The icon object
15891     */
15892    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15893    /**
15894     * @brief Unset the icon used for the check object
15895     *
15896     * @param obj The check object
15897     * @return The icon object that was being used
15898     *
15899     * Unparent and return the icon object which was set for this widget.
15900     */
15901    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15902    /**
15903     * @brief Set the on/off state of the check object
15904     *
15905     * @param obj The check object
15906     * @param state The state to use (1 == on, 0 == off)
15907     *
15908     * This sets the state of the check. If set
15909     * with elm_check_state_pointer_set() the state of that variable is also
15910     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
15911     */
15912    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
15913    /**
15914     * @brief Get the state of the check object
15915     *
15916     * @param obj The check object
15917     * @return The boolean state
15918     */
15919    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15920    /**
15921     * @brief Set a convenience pointer to a boolean to change
15922     *
15923     * @param obj The check object
15924     * @param statep Pointer to the boolean to modify
15925     *
15926     * This sets a pointer to a boolean, that, in addition to the check objects
15927     * state will also be modified directly. To stop setting the object pointed
15928     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
15929     * then when this is called, the check objects state will also be modified to
15930     * reflect the value of the boolean @p statep points to, just like calling
15931     * elm_check_state_set().
15932     */
15933    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
15934    /**
15935     * @}
15936     */
15937
15938    /**
15939     * @defgroup Radio Radio
15940     *
15941     * @image html img/widget/radio/preview-00.png
15942     * @image latex img/widget/radio/preview-00.eps
15943     *
15944     * @brief Radio is a widget that allows for 1 or more options to be displayed
15945     * and have the user choose only 1 of them.
15946     *
15947     * A radio object contains an indicator, an optional Label and an optional
15948     * icon object. While it's possible to have a group of only one radio they,
15949     * are normally used in groups of 2 or more. To add a radio to a group use
15950     * elm_radio_group_add(). The radio object(s) will select from one of a set
15951     * of integer values, so any value they are configuring needs to be mapped to
15952     * a set of integers. To configure what value that radio object represents,
15953     * use  elm_radio_state_value_set() to set the integer it represents. To set
15954     * the value the whole group(which one is currently selected) is to indicate
15955     * use elm_radio_value_set() on any group member, and to get the groups value
15956     * use elm_radio_value_get(). For convenience the radio objects are also able
15957     * to directly set an integer(int) to the value that is selected. To specify
15958     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
15959     * The radio objects will modify this directly. That implies the pointer must
15960     * point to valid memory for as long as the radio objects exist.
15961     *
15962     * Signals that you can add callbacks for are:
15963     * @li changed - This is called whenever the user changes the state of one of
15964     * the radio objects within the group of radio objects that work together.
15965     *
15966     * @ref tutorial_radio show most of this API in action.
15967     * @{
15968     */
15969    /**
15970     * @brief Add a new radio to the parent
15971     *
15972     * @param parent The parent object
15973     * @return The new object or NULL if it cannot be created
15974     */
15975    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15976    /**
15977     * @brief Set the text label of the radio object
15978     *
15979     * @param obj The radio object
15980     * @param label The text label string in UTF-8
15981     *
15982     * @deprecated use elm_object_text_set() instead.
15983     */
15984    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15985    /**
15986     * @brief Get the text label of the radio object
15987     *
15988     * @param obj The radio object
15989     * @return The text label string in UTF-8
15990     *
15991     * @deprecated use elm_object_text_set() instead.
15992     */
15993    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15994    /**
15995     * @brief Set the icon object of the radio object
15996     *
15997     * @param obj The radio object
15998     * @param icon The icon object
15999     *
16000     * Once the icon object is set, a previously set one will be deleted. If you
16001     * want to keep that old content object, use the elm_radio_icon_unset()
16002     * function.
16003     */
16004    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16005    /**
16006     * @brief Get the icon object of the radio object
16007     *
16008     * @param obj The radio object
16009     * @return The icon object
16010     *
16011     * @see elm_radio_icon_set()
16012     */
16013    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16014    /**
16015     * @brief Unset the icon used for the radio object
16016     *
16017     * @param obj The radio object
16018     * @return The icon object that was being used
16019     *
16020     * Unparent and return the icon object which was set for this widget.
16021     *
16022     * @see elm_radio_icon_set()
16023     */
16024    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16025    /**
16026     * @brief Add this radio to a group of other radio objects
16027     *
16028     * @param obj The radio object
16029     * @param group Any object whose group the @p obj is to join.
16030     *
16031     * Radio objects work in groups. Each member should have a different integer
16032     * value assigned. In order to have them work as a group, they need to know
16033     * about each other. This adds the given radio object to the group of which
16034     * the group object indicated is a member.
16035     */
16036    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
16037    /**
16038     * @brief Set the integer value that this radio object represents
16039     *
16040     * @param obj The radio object
16041     * @param value The value to use if this radio object is selected
16042     *
16043     * This sets the value of the radio.
16044     */
16045    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16046    /**
16047     * @brief Get the integer value that this radio object represents
16048     *
16049     * @param obj The radio object
16050     * @return The value used if this radio object is selected
16051     *
16052     * This gets the value of the radio.
16053     *
16054     * @see elm_radio_value_set()
16055     */
16056    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16057    /**
16058     * @brief Set the value of the radio.
16059     *
16060     * @param obj The radio object
16061     * @param value The value to use for the group
16062     *
16063     * This sets the value of the radio group and will also set the value if
16064     * pointed to, to the value supplied, but will not call any callbacks.
16065     */
16066    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16067    /**
16068     * @brief Get the state of the radio object
16069     *
16070     * @param obj The radio object
16071     * @return The integer state
16072     */
16073    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16074    /**
16075     * @brief Set a convenience pointer to a integer to change
16076     *
16077     * @param obj The radio object
16078     * @param valuep Pointer to the integer to modify
16079     *
16080     * This sets a pointer to a integer, that, in addition to the radio objects
16081     * state will also be modified directly. To stop setting the object pointed
16082     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
16083     * when this is called, the radio objects state will also be modified to
16084     * reflect the value of the integer valuep points to, just like calling
16085     * elm_radio_value_set().
16086     */
16087    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16088    /**
16089     * @}
16090     */
16091
16092    /**
16093     * @defgroup Pager Pager
16094     *
16095     * @image html img/widget/pager/preview-00.png
16096     * @image latex img/widget/pager/preview-00.eps
16097     *
16098     * @brief Widget that allows flipping between 1 or more “pages” of objects.
16099     *
16100     * The flipping between “pages” of objects is animated. All content in pager
16101     * is kept in a stack, the last content to be added will be on the top of the
16102     * stack(be visible).
16103     *
16104     * Objects can be pushed or popped from the stack or deleted as normal.
16105     * Pushes and pops will animate (and a pop will delete the object once the
16106     * animation is finished). Any object already in the pager can be promoted to
16107     * the top(from its current stacking position) through the use of
16108     * elm_pager_content_promote(). Objects are pushed to the top with
16109     * elm_pager_content_push() and when the top item is no longer wanted, simply
16110     * pop it with elm_pager_content_pop() and it will also be deleted. If an
16111     * object is no longer needed and is not the top item, just delete it as
16112     * normal. You can query which objects are the top and bottom with
16113     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16114     *
16115     * Signals that you can add callbacks for are:
16116     * "hide,finished" - when the previous page is hided
16117     *
16118     * This widget has the following styles available:
16119     * @li default
16120     * @li fade
16121     * @li fade_translucide
16122     * @li fade_invisible
16123     * @note This styles affect only the flipping animations, the appearance when
16124     * not animating is unaffected by styles.
16125     *
16126     * @ref tutorial_pager gives a good overview of the usage of the API.
16127     * @{
16128     */
16129    /**
16130     * Add a new pager to the parent
16131     *
16132     * @param parent The parent object
16133     * @return The new object or NULL if it cannot be created
16134     *
16135     * @ingroup Pager
16136     */
16137    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16138    /**
16139     * @brief Push an object to the top of the pager stack (and show it).
16140     *
16141     * @param obj The pager object
16142     * @param content The object to push
16143     *
16144     * The object pushed becomes a child of the pager, it will be controlled and
16145     * deleted when the pager is deleted.
16146     *
16147     * @note If the content is already in the stack use
16148     * elm_pager_content_promote().
16149     * @warning Using this function on @p content already in the stack results in
16150     * undefined behavior.
16151     */
16152    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16153    /**
16154     * @brief Pop the object that is on top of the stack
16155     *
16156     * @param obj The pager object
16157     *
16158     * This pops the object that is on the top(visible) of the pager, makes it
16159     * disappear, then deletes the object. The object that was underneath it on
16160     * the stack will become visible.
16161     */
16162    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16163    /**
16164     * @brief Moves an object already in the pager stack to the top of the stack.
16165     *
16166     * @param obj The pager object
16167     * @param content The object to promote
16168     *
16169     * This will take the @p content and move it to the top of the stack as
16170     * if it had been pushed there.
16171     *
16172     * @note If the content isn't already in the stack use
16173     * elm_pager_content_push().
16174     * @warning Using this function on @p content not already in the stack
16175     * results in undefined behavior.
16176     */
16177    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16178    /**
16179     * @brief Return the object at the bottom of the pager stack
16180     *
16181     * @param obj The pager object
16182     * @return The bottom object or NULL if none
16183     */
16184    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16185    /**
16186     * @brief  Return the object at the top of the pager stack
16187     *
16188     * @param obj The pager object
16189     * @return The top object or NULL if none
16190     */
16191    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16192    /**
16193     * @}
16194     */
16195
16196    /**
16197     * @defgroup Slideshow Slideshow
16198     *
16199     * @image html img/widget/slideshow/preview-00.png
16200     * @image latex img/widget/slideshow/preview-00.eps
16201     *
16202     * This widget, as the name indicates, is a pre-made image
16203     * slideshow panel, with API functions acting on (child) image
16204     * items presentation. Between those actions, are:
16205     * - advance to next/previous image
16206     * - select the style of image transition animation
16207     * - set the exhibition time for each image
16208     * - start/stop the slideshow
16209     *
16210     * The transition animations are defined in the widget's theme,
16211     * consequently new animations can be added without having to
16212     * update the widget's code.
16213     *
16214     * @section Slideshow_Items Slideshow items
16215     *
16216     * For slideshow items, just like for @ref Genlist "genlist" ones,
16217     * the user defines a @b classes, specifying functions that will be
16218     * called on the item's creation and deletion times.
16219     *
16220     * The #Elm_Slideshow_Item_Class structure contains the following
16221     * members:
16222     *
16223     * - @c func.get - When an item is displayed, this function is
16224     *   called, and it's where one should create the item object, de
16225     *   facto. For example, the object can be a pure Evas image object
16226     *   or an Elementary @ref Photocam "photocam" widget. See
16227     *   #SlideshowItemGetFunc.
16228     * - @c func.del - When an item is no more displayed, this function
16229     *   is called, where the user must delete any data associated to
16230     *   the item. See #SlideshowItemDelFunc.
16231     *
16232     * @section Slideshow_Caching Slideshow caching
16233     *
16234     * The slideshow provides facilities to have items adjacent to the
16235     * one being displayed <b>already "realized"</b> (i.e. loaded) for
16236     * you, so that the system does not have to decode image data
16237     * anymore at the time it has to actually switch images on its
16238     * viewport. The user is able to set the numbers of items to be
16239     * cached @b before and @b after the current item, in the widget's
16240     * item list.
16241     *
16242     * Smart events one can add callbacks for are:
16243     *
16244     * - @c "changed" - when the slideshow switches its view to a new
16245     *   item
16246     *
16247     * List of examples for the slideshow widget:
16248     * @li @ref slideshow_example
16249     */
16250
16251    /**
16252     * @addtogroup Slideshow
16253     * @{
16254     */
16255
16256    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16257    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16258    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
16259    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16260    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16261
16262    /**
16263     * @struct _Elm_Slideshow_Item_Class
16264     *
16265     * Slideshow item class definition. See @ref Slideshow_Items for
16266     * field details.
16267     */
16268    struct _Elm_Slideshow_Item_Class
16269      {
16270         struct _Elm_Slideshow_Item_Class_Func
16271           {
16272              SlideshowItemGetFunc get;
16273              SlideshowItemDelFunc del;
16274           } func;
16275      }; /**< #Elm_Slideshow_Item_Class member definitions */
16276
16277    /**
16278     * Add a new slideshow widget to the given parent Elementary
16279     * (container) object
16280     *
16281     * @param parent The parent object
16282     * @return A new slideshow widget handle or @c NULL, on errors
16283     *
16284     * This function inserts a new slideshow widget on the canvas.
16285     *
16286     * @ingroup Slideshow
16287     */
16288    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16289
16290    /**
16291     * Add (append) a new item in a given slideshow widget.
16292     *
16293     * @param obj The slideshow object
16294     * @param itc The item class for the item
16295     * @param data The item's data
16296     * @return A handle to the item added or @c NULL, on errors
16297     *
16298     * Add a new item to @p obj's internal list of items, appending it.
16299     * The item's class must contain the function really fetching the
16300     * image object to show for this item, which could be an Evas image
16301     * object or an Elementary photo, for example. The @p data
16302     * parameter is going to be passed to both class functions of the
16303     * item.
16304     *
16305     * @see #Elm_Slideshow_Item_Class
16306     * @see elm_slideshow_item_sorted_insert()
16307     *
16308     * @ingroup Slideshow
16309     */
16310    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16311
16312    /**
16313     * Insert a new item into the given slideshow widget, using the @p func
16314     * function to sort items (by item handles).
16315     *
16316     * @param obj The slideshow object
16317     * @param itc The item class for the item
16318     * @param data The item's data
16319     * @param func The comparing function to be used to sort slideshow
16320     * items <b>by #Elm_Slideshow_Item item handles</b>
16321     * @return Returns The slideshow item handle, on success, or
16322     * @c NULL, on errors
16323     *
16324     * Add a new item to @p obj's internal list of items, in a position
16325     * determined by the @p func comparing function. The item's class
16326     * must contain the function really fetching the image object to
16327     * show for this item, which could be an Evas image object or an
16328     * Elementary photo, for example. The @p data parameter is going to
16329     * be passed to both class functions of the item.
16330     *
16331     * @see #Elm_Slideshow_Item_Class
16332     * @see elm_slideshow_item_add()
16333     *
16334     * @ingroup Slideshow
16335     */
16336    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);
16337
16338    /**
16339     * Display a given slideshow widget's item, programmatically.
16340     *
16341     * @param obj The slideshow object
16342     * @param item The item to display on @p obj's viewport
16343     *
16344     * The change between the current item and @p item will use the
16345     * transition @p obj is set to use (@see
16346     * elm_slideshow_transition_set()).
16347     *
16348     * @ingroup Slideshow
16349     */
16350    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16351
16352    /**
16353     * Slide to the @b next item, in a given slideshow widget
16354     *
16355     * @param obj The slideshow object
16356     *
16357     * The sliding animation @p obj is set to use will be the
16358     * transition effect used, after this call is issued.
16359     *
16360     * @note If the end of the slideshow's internal list of items is
16361     * reached, it'll wrap around to the list's beginning, again.
16362     *
16363     * @ingroup Slideshow
16364     */
16365    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16366
16367    /**
16368     * Slide to the @b previous item, in a given slideshow widget
16369     *
16370     * @param obj The slideshow object
16371     *
16372     * The sliding animation @p obj is set to use will be the
16373     * transition effect used, after this call is issued.
16374     *
16375     * @note If the beginning of the slideshow's internal list of items
16376     * is reached, it'll wrap around to the list's end, again.
16377     *
16378     * @ingroup Slideshow
16379     */
16380    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16381
16382    /**
16383     * Returns the list of sliding transition/effect names available, for a
16384     * given slideshow widget.
16385     *
16386     * @param obj The slideshow object
16387     * @return The list of transitions (list of @b stringshared strings
16388     * as data)
16389     *
16390     * The transitions, which come from @p obj's theme, must be an EDC
16391     * data item named @c "transitions" on the theme file, with (prefix)
16392     * names of EDC programs actually implementing them.
16393     *
16394     * The available transitions for slideshows on the default theme are:
16395     * - @c "fade" - the current item fades out, while the new one
16396     *   fades in to the slideshow's viewport.
16397     * - @c "black_fade" - the current item fades to black, and just
16398     *   then, the new item will fade in.
16399     * - @c "horizontal" - the current item slides horizontally, until
16400     *   it gets out of the slideshow's viewport, while the new item
16401     *   comes from the left to take its place.
16402     * - @c "vertical" - the current item slides vertically, until it
16403     *   gets out of the slideshow's viewport, while the new item comes
16404     *   from the bottom to take its place.
16405     * - @c "square" - the new item starts to appear from the middle of
16406     *   the current one, but with a tiny size, growing until its
16407     *   target (full) size and covering the old one.
16408     *
16409     * @warning The stringshared strings get no new references
16410     * exclusive to the user grabbing the list, here, so if you'd like
16411     * to use them out of this call's context, you'd better @c
16412     * eina_stringshare_ref() them.
16413     *
16414     * @see elm_slideshow_transition_set()
16415     *
16416     * @ingroup Slideshow
16417     */
16418    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16419
16420    /**
16421     * Set the current slide transition/effect in use for a given
16422     * slideshow widget
16423     *
16424     * @param obj The slideshow object
16425     * @param transition The new transition's name string
16426     *
16427     * If @p transition is implemented in @p obj's theme (i.e., is
16428     * contained in the list returned by
16429     * elm_slideshow_transitions_get()), this new sliding effect will
16430     * be used on the widget.
16431     *
16432     * @see elm_slideshow_transitions_get() for more details
16433     *
16434     * @ingroup Slideshow
16435     */
16436    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16437
16438    /**
16439     * Get the current slide transition/effect in use for a given
16440     * slideshow widget
16441     *
16442     * @param obj The slideshow object
16443     * @return The current transition's name
16444     *
16445     * @see elm_slideshow_transition_set() for more details
16446     *
16447     * @ingroup Slideshow
16448     */
16449    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16450
16451    /**
16452     * Set the interval between each image transition on a given
16453     * slideshow widget, <b>and start the slideshow, itself</b>
16454     *
16455     * @param obj The slideshow object
16456     * @param timeout The new displaying timeout for images
16457     *
16458     * After this call, the slideshow widget will start cycling its
16459     * view, sequentially and automatically, with the images of the
16460     * items it has. The time between each new image displayed is going
16461     * to be @p timeout, in @b seconds. If a different timeout was set
16462     * previously and an slideshow was in progress, it will continue
16463     * with the new time between transitions, after this call.
16464     *
16465     * @note A value less than or equal to 0 on @p timeout will disable
16466     * the widget's internal timer, thus halting any slideshow which
16467     * could be happening on @p obj.
16468     *
16469     * @see elm_slideshow_timeout_get()
16470     *
16471     * @ingroup Slideshow
16472     */
16473    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16474
16475    /**
16476     * Get the interval set for image transitions on a given slideshow
16477     * widget.
16478     *
16479     * @param obj The slideshow object
16480     * @return Returns the timeout set on it
16481     *
16482     * @see elm_slideshow_timeout_set() for more details
16483     *
16484     * @ingroup Slideshow
16485     */
16486    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16487
16488    /**
16489     * Set if, after a slideshow is started, for a given slideshow
16490     * widget, its items should be displayed cyclically or not.
16491     *
16492     * @param obj The slideshow object
16493     * @param loop Use @c EINA_TRUE to make it cycle through items or
16494     * @c EINA_FALSE for it to stop at the end of @p obj's internal
16495     * list of items
16496     *
16497     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16498     * ignore what is set by this functions, i.e., they'll @b always
16499     * cycle through items. This affects only the "automatic"
16500     * slideshow, as set by elm_slideshow_timeout_set().
16501     *
16502     * @see elm_slideshow_loop_get()
16503     *
16504     * @ingroup Slideshow
16505     */
16506    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16507
16508    /**
16509     * Get if, after a slideshow is started, for a given slideshow
16510     * widget, its items are to be displayed cyclically or not.
16511     *
16512     * @param obj The slideshow object
16513     * @return @c EINA_TRUE, if the items in @p obj will be cycled
16514     * through or @c EINA_FALSE, otherwise
16515     *
16516     * @see elm_slideshow_loop_set() for more details
16517     *
16518     * @ingroup Slideshow
16519     */
16520    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16521
16522    /**
16523     * Remove all items from a given slideshow widget
16524     *
16525     * @param obj The slideshow object
16526     *
16527     * This removes (and deletes) all items in @p obj, leaving it
16528     * empty.
16529     *
16530     * @see elm_slideshow_item_del(), to remove just one item.
16531     *
16532     * @ingroup Slideshow
16533     */
16534    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16535
16536    /**
16537     * Get the internal list of items in a given slideshow widget.
16538     *
16539     * @param obj The slideshow object
16540     * @return The list of items (#Elm_Slideshow_Item as data) or
16541     * @c NULL on errors.
16542     *
16543     * This list is @b not to be modified in any way and must not be
16544     * freed. Use the list members with functions like
16545     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16546     *
16547     * @warning This list is only valid until @p obj object's internal
16548     * items list is changed. It should be fetched again with another
16549     * call to this function when changes happen.
16550     *
16551     * @ingroup Slideshow
16552     */
16553    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16554
16555    /**
16556     * Delete a given item from a slideshow widget.
16557     *
16558     * @param item The slideshow item
16559     *
16560     * @ingroup Slideshow
16561     */
16562    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16563
16564    /**
16565     * Return the data associated with a given slideshow item
16566     *
16567     * @param item The slideshow item
16568     * @return Returns the data associated to this item
16569     *
16570     * @ingroup Slideshow
16571     */
16572    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16573
16574    /**
16575     * Returns the currently displayed item, in a given slideshow widget
16576     *
16577     * @param obj The slideshow object
16578     * @return A handle to the item being displayed in @p obj or
16579     * @c NULL, if none is (and on errors)
16580     *
16581     * @ingroup Slideshow
16582     */
16583    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16584
16585    /**
16586     * Get the real Evas object created to implement the view of a
16587     * given slideshow item
16588     *
16589     * @param item The slideshow item.
16590     * @return the Evas object implementing this item's view.
16591     *
16592     * This returns the actual Evas object used to implement the
16593     * specified slideshow item's view. This may be @c NULL, as it may
16594     * not have been created or may have been deleted, at any time, by
16595     * the slideshow. <b>Do not modify this object</b> (move, resize,
16596     * show, hide, etc.), as the slideshow is controlling it. This
16597     * function is for querying, emitting custom signals or hooking
16598     * lower level callbacks for events on that object. Do not delete
16599     * this object under any circumstances.
16600     *
16601     * @see elm_slideshow_item_data_get()
16602     *
16603     * @ingroup Slideshow
16604     */
16605    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16606
16607    /**
16608     * Get the the item, in a given slideshow widget, placed at
16609     * position @p nth, in its internal items list
16610     *
16611     * @param obj The slideshow object
16612     * @param nth The number of the item to grab a handle to (0 being
16613     * the first)
16614     * @return The item stored in @p obj at position @p nth or @c NULL,
16615     * if there's no item with that index (and on errors)
16616     *
16617     * @ingroup Slideshow
16618     */
16619    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16620
16621    /**
16622     * Set the current slide layout in use for a given slideshow widget
16623     *
16624     * @param obj The slideshow object
16625     * @param layout The new layout's name string
16626     *
16627     * If @p layout is implemented in @p obj's theme (i.e., is contained
16628     * in the list returned by elm_slideshow_layouts_get()), this new
16629     * images layout will be used on the widget.
16630     *
16631     * @see elm_slideshow_layouts_get() for more details
16632     *
16633     * @ingroup Slideshow
16634     */
16635    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16636
16637    /**
16638     * Get the current slide layout in use for a given slideshow widget
16639     *
16640     * @param obj The slideshow object
16641     * @return The current layout's name
16642     *
16643     * @see elm_slideshow_layout_set() for more details
16644     *
16645     * @ingroup Slideshow
16646     */
16647    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16648
16649    /**
16650     * Returns the list of @b layout names available, for a given
16651     * slideshow widget.
16652     *
16653     * @param obj The slideshow object
16654     * @return The list of layouts (list of @b stringshared strings
16655     * as data)
16656     *
16657     * Slideshow layouts will change how the widget is to dispose each
16658     * image item in its viewport, with regard to cropping, scaling,
16659     * etc.
16660     *
16661     * The layouts, which come from @p obj's theme, must be an EDC
16662     * data item name @c "layouts" on the theme file, with (prefix)
16663     * names of EDC programs actually implementing them.
16664     *
16665     * The available layouts for slideshows on the default theme are:
16666     * - @c "fullscreen" - item images with original aspect, scaled to
16667     *   touch top and down slideshow borders or, if the image's heigh
16668     *   is not enough, left and right slideshow borders.
16669     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16670     *   one, but always leaving 10% of the slideshow's dimensions of
16671     *   distance between the item image's borders and the slideshow
16672     *   borders, for each axis.
16673     *
16674     * @warning The stringshared strings get no new references
16675     * exclusive to the user grabbing the list, here, so if you'd like
16676     * to use them out of this call's context, you'd better @c
16677     * eina_stringshare_ref() them.
16678     *
16679     * @see elm_slideshow_layout_set()
16680     *
16681     * @ingroup Slideshow
16682     */
16683    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16684
16685    /**
16686     * Set the number of items to cache, on a given slideshow widget,
16687     * <b>before the current item</b>
16688     *
16689     * @param obj The slideshow object
16690     * @param count Number of items to cache before the current one
16691     *
16692     * The default value for this property is @c 2. See
16693     * @ref Slideshow_Caching "slideshow caching" for more details.
16694     *
16695     * @see elm_slideshow_cache_before_get()
16696     *
16697     * @ingroup Slideshow
16698     */
16699    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16700
16701    /**
16702     * Retrieve the number of items to cache, on a given slideshow widget,
16703     * <b>before the current item</b>
16704     *
16705     * @param obj The slideshow object
16706     * @return The number of items set to be cached before the current one
16707     *
16708     * @see elm_slideshow_cache_before_set() for more details
16709     *
16710     * @ingroup Slideshow
16711     */
16712    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16713
16714    /**
16715     * Set the number of items to cache, on a given slideshow widget,
16716     * <b>after the current item</b>
16717     *
16718     * @param obj The slideshow object
16719     * @param count Number of items to cache after the current one
16720     *
16721     * The default value for this property is @c 2. See
16722     * @ref Slideshow_Caching "slideshow caching" for more details.
16723     *
16724     * @see elm_slideshow_cache_after_get()
16725     *
16726     * @ingroup Slideshow
16727     */
16728    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16729
16730    /**
16731     * Retrieve the number of items to cache, on a given slideshow widget,
16732     * <b>after the current item</b>
16733     *
16734     * @param obj The slideshow object
16735     * @return The number of items set to be cached after the current one
16736     *
16737     * @see elm_slideshow_cache_after_set() for more details
16738     *
16739     * @ingroup Slideshow
16740     */
16741    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16742
16743    /**
16744     * Get the number of items stored in a given slideshow widget
16745     *
16746     * @param obj The slideshow object
16747     * @return The number of items on @p obj, at the moment of this call
16748     *
16749     * @ingroup Slideshow
16750     */
16751    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16752
16753    /**
16754     * @}
16755     */
16756
16757    /**
16758     * @defgroup Fileselector File Selector
16759     *
16760     * @image html img/widget/fileselector/preview-00.png
16761     * @image latex img/widget/fileselector/preview-00.eps
16762     *
16763     * A file selector is a widget that allows a user to navigate
16764     * through a file system, reporting file selections back via its
16765     * API.
16766     *
16767     * It contains shortcut buttons for home directory (@c ~) and to
16768     * jump one directory upwards (..), as well as cancel/ok buttons to
16769     * confirm/cancel a given selection. After either one of those two
16770     * former actions, the file selector will issue its @c "done" smart
16771     * callback.
16772     *
16773     * There's a text entry on it, too, showing the name of the current
16774     * selection. There's the possibility of making it editable, so it
16775     * is useful on file saving dialogs on applications, where one
16776     * gives a file name to save contents to, in a given directory in
16777     * the system. This custom file name will be reported on the @c
16778     * "done" smart callback (explained in sequence).
16779     *
16780     * Finally, it has a view to display file system items into in two
16781     * possible forms:
16782     * - list
16783     * - grid
16784     *
16785     * If Elementary is built with support of the Ethumb thumbnailing
16786     * library, the second form of view will display preview thumbnails
16787     * of files which it supports.
16788     *
16789     * Smart callbacks one can register to:
16790     *
16791     * - @c "selected" - the user has clicked on a file (when not in
16792     *      folders-only mode) or directory (when in folders-only mode)
16793     * - @c "directory,open" - the list has been populated with new
16794     *      content (@c event_info is a pointer to the directory's
16795     *      path, a @b stringshared string)
16796     * - @c "done" - the user has clicked on the "ok" or "cancel"
16797     *      buttons (@c event_info is a pointer to the selection's
16798     *      path, a @b stringshared string)
16799     *
16800     * Here is an example on its usage:
16801     * @li @ref fileselector_example
16802     */
16803
16804    /**
16805     * @addtogroup Fileselector
16806     * @{
16807     */
16808
16809    /**
16810     * Defines how a file selector widget is to layout its contents
16811     * (file system entries).
16812     */
16813    typedef enum _Elm_Fileselector_Mode
16814      {
16815         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
16816         ELM_FILESELECTOR_GRID, /**< layout as a grid */
16817         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
16818      } Elm_Fileselector_Mode;
16819
16820    /**
16821     * Add a new file selector widget to the given parent Elementary
16822     * (container) object
16823     *
16824     * @param parent The parent object
16825     * @return a new file selector widget handle or @c NULL, on errors
16826     *
16827     * This function inserts a new file selector widget on the canvas.
16828     *
16829     * @ingroup Fileselector
16830     */
16831    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16832
16833    /**
16834     * Enable/disable the file name entry box where the user can type
16835     * in a name for a file, in a given file selector widget
16836     *
16837     * @param obj The file selector object
16838     * @param is_save @c EINA_TRUE to make the file selector a "saving
16839     * dialog", @c EINA_FALSE otherwise
16840     *
16841     * Having the entry editable is useful on file saving dialogs on
16842     * applications, where one gives a file name to save contents to,
16843     * in a given directory in the system. This custom file name will
16844     * be reported on the @c "done" smart callback.
16845     *
16846     * @see elm_fileselector_is_save_get()
16847     *
16848     * @ingroup Fileselector
16849     */
16850    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
16851
16852    /**
16853     * Get whether the given file selector is in "saving dialog" mode
16854     *
16855     * @param obj The file selector object
16856     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
16857     * mode, @c EINA_FALSE otherwise (and on errors)
16858     *
16859     * @see elm_fileselector_is_save_set() for more details
16860     *
16861     * @ingroup Fileselector
16862     */
16863    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16864
16865    /**
16866     * Enable/disable folder-only view for a given file selector widget
16867     *
16868     * @param obj The file selector object
16869     * @param only @c EINA_TRUE to make @p obj only display
16870     * directories, @c EINA_FALSE to make files to be displayed in it
16871     * too
16872     *
16873     * If enabled, the widget's view will only display folder items,
16874     * naturally.
16875     *
16876     * @see elm_fileselector_folder_only_get()
16877     *
16878     * @ingroup Fileselector
16879     */
16880    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
16881
16882    /**
16883     * Get whether folder-only view is set for a given file selector
16884     * widget
16885     *
16886     * @param obj The file selector object
16887     * @return only @c EINA_TRUE if @p obj is only displaying
16888     * directories, @c EINA_FALSE if files are being displayed in it
16889     * too (and on errors)
16890     *
16891     * @see elm_fileselector_folder_only_get()
16892     *
16893     * @ingroup Fileselector
16894     */
16895    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16896
16897    /**
16898     * Enable/disable the "ok" and "cancel" buttons on a given file
16899     * selector widget
16900     *
16901     * @param obj The file selector object
16902     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
16903     *
16904     * @note A file selector without those buttons will never emit the
16905     * @c "done" smart event, and is only usable if one is just hooking
16906     * to the other two events.
16907     *
16908     * @see elm_fileselector_buttons_ok_cancel_get()
16909     *
16910     * @ingroup Fileselector
16911     */
16912    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
16913
16914    /**
16915     * Get whether the "ok" and "cancel" buttons on a given file
16916     * selector widget are being shown.
16917     *
16918     * @param obj The file selector object
16919     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
16920     * otherwise (and on errors)
16921     *
16922     * @see elm_fileselector_buttons_ok_cancel_set() for more details
16923     *
16924     * @ingroup Fileselector
16925     */
16926    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16927
16928    /**
16929     * Enable/disable a tree view in the given file selector widget,
16930     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
16931     *
16932     * @param obj The file selector object
16933     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
16934     * disable
16935     *
16936     * In a tree view, arrows are created on the sides of directories,
16937     * allowing them to expand in place.
16938     *
16939     * @note If it's in other mode, the changes made by this function
16940     * will only be visible when one switches back to "list" mode.
16941     *
16942     * @see elm_fileselector_expandable_get()
16943     *
16944     * @ingroup Fileselector
16945     */
16946    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
16947
16948    /**
16949     * Get whether tree view is enabled for the given file selector
16950     * widget
16951     *
16952     * @param obj The file selector object
16953     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
16954     * otherwise (and or errors)
16955     *
16956     * @see elm_fileselector_expandable_set() for more details
16957     *
16958     * @ingroup Fileselector
16959     */
16960    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16961
16962    /**
16963     * Set, programmatically, the @b directory that a given file
16964     * selector widget will display contents from
16965     *
16966     * @param obj The file selector object
16967     * @param path The path to display in @p obj
16968     *
16969     * This will change the @b directory that @p obj is displaying. It
16970     * will also clear the text entry area on the @p obj object, which
16971     * displays select files' names.
16972     *
16973     * @see elm_fileselector_path_get()
16974     *
16975     * @ingroup Fileselector
16976     */
16977    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
16978
16979    /**
16980     * Get the parent directory's path that a given file selector
16981     * widget is displaying
16982     *
16983     * @param obj The file selector object
16984     * @return The (full) path of the directory the file selector is
16985     * displaying, a @b stringshared string
16986     *
16987     * @see elm_fileselector_path_set()
16988     *
16989     * @ingroup Fileselector
16990     */
16991    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16992
16993    /**
16994     * Set, programmatically, the currently selected file/directory in
16995     * the given file selector widget
16996     *
16997     * @param obj The file selector object
16998     * @param path The (full) path to a file or directory
16999     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
17000     * latter case occurs if the directory or file pointed to do not
17001     * exist.
17002     *
17003     * @see elm_fileselector_selected_get()
17004     *
17005     * @ingroup Fileselector
17006     */
17007    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17008
17009    /**
17010     * Get the currently selected item's (full) path, in the given file
17011     * selector widget
17012     *
17013     * @param obj The file selector object
17014     * @return The absolute path of the selected item, a @b
17015     * stringshared string
17016     *
17017     * @note Custom editions on @p obj object's text entry, if made,
17018     * will appear on the return string of this function, naturally.
17019     *
17020     * @see elm_fileselector_selected_set() for more details
17021     *
17022     * @ingroup Fileselector
17023     */
17024    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17025
17026    /**
17027     * Set the mode in which a given file selector widget will display
17028     * (layout) file system entries in its view
17029     *
17030     * @param obj The file selector object
17031     * @param mode The mode of the fileselector, being it one of
17032     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
17033     * first one, naturally, will display the files in a list. The
17034     * latter will make the widget to display its entries in a grid
17035     * form.
17036     *
17037     * @note By using elm_fileselector_expandable_set(), the user may
17038     * trigger a tree view for that list.
17039     *
17040     * @note If Elementary is built with support of the Ethumb
17041     * thumbnailing library, the second form of view will display
17042     * preview thumbnails of files which it supports. You must have
17043     * elm_need_ethumb() called in your Elementary for thumbnailing to
17044     * work, though.
17045     *
17046     * @see elm_fileselector_expandable_set().
17047     * @see elm_fileselector_mode_get().
17048     *
17049     * @ingroup Fileselector
17050     */
17051    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
17052
17053    /**
17054     * Get the mode in which a given file selector widget is displaying
17055     * (layouting) file system entries in its view
17056     *
17057     * @param obj The fileselector object
17058     * @return The mode in which the fileselector is at
17059     *
17060     * @see elm_fileselector_mode_set() for more details
17061     *
17062     * @ingroup Fileselector
17063     */
17064    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17065
17066    /**
17067     * @}
17068     */
17069
17070    /**
17071     * @defgroup Progressbar Progress bar
17072     *
17073     * The progress bar is a widget for visually representing the
17074     * progress status of a given job/task.
17075     *
17076     * A progress bar may be horizontal or vertical. It may display an
17077     * icon besides it, as well as primary and @b units labels. The
17078     * former is meant to label the widget as a whole, while the
17079     * latter, which is formatted with floating point values (and thus
17080     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
17081     * units"</c>), is meant to label the widget's <b>progress
17082     * value</b>. Label, icon and unit strings/objects are @b optional
17083     * for progress bars.
17084     *
17085     * A progress bar may be @b inverted, in which state it gets its
17086     * values inverted, with high values being on the left or top and
17087     * low values on the right or bottom, as opposed to normally have
17088     * the low values on the former and high values on the latter,
17089     * respectively, for horizontal and vertical modes.
17090     *
17091     * The @b span of the progress, as set by
17092     * elm_progressbar_span_size_set(), is its length (horizontally or
17093     * vertically), unless one puts size hints on the widget to expand
17094     * on desired directions, by any container. That length will be
17095     * scaled by the object or applications scaling factor. At any
17096     * point code can query the progress bar for its value with
17097     * elm_progressbar_value_get().
17098     *
17099     * Available widget styles for progress bars:
17100     * - @c "default"
17101     * - @c "wheel" (simple style, no text, no progression, only
17102     *      "pulse" effect is available)
17103     *
17104     * Here is an example on its usage:
17105     * @li @ref progressbar_example
17106     */
17107
17108    /**
17109     * Add a new progress bar widget to the given parent Elementary
17110     * (container) object
17111     *
17112     * @param parent The parent object
17113     * @return a new progress bar widget handle or @c NULL, on errors
17114     *
17115     * This function inserts a new progress bar widget on the canvas.
17116     *
17117     * @ingroup Progressbar
17118     */
17119    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17120
17121    /**
17122     * Set whether a given progress bar widget is at "pulsing mode" or
17123     * not.
17124     *
17125     * @param obj The progress bar object
17126     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17127     * @c EINA_FALSE to put it back to its default one
17128     *
17129     * By default, progress bars will display values from the low to
17130     * high value boundaries. There are, though, contexts in which the
17131     * state of progression of a given task is @b unknown.  For those,
17132     * one can set a progress bar widget to a "pulsing state", to give
17133     * the user an idea that some computation is being held, but
17134     * without exact progress values. In the default theme it will
17135     * animate its bar with the contents filling in constantly and back
17136     * to non-filled, in a loop. To start and stop this pulsing
17137     * animation, one has to explicitly call elm_progressbar_pulse().
17138     *
17139     * @see elm_progressbar_pulse_get()
17140     * @see elm_progressbar_pulse()
17141     *
17142     * @ingroup Progressbar
17143     */
17144    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17145
17146    /**
17147     * Get whether a given progress bar widget is at "pulsing mode" or
17148     * not.
17149     *
17150     * @param obj The progress bar object
17151     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17152     * if it's in the default one (and on errors)
17153     *
17154     * @ingroup Progressbar
17155     */
17156    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17157
17158    /**
17159     * Start/stop a given progress bar "pulsing" animation, if its
17160     * under that mode
17161     *
17162     * @param obj The progress bar object
17163     * @param state @c EINA_TRUE, to @b start the pulsing animation,
17164     * @c EINA_FALSE to @b stop it
17165     *
17166     * @note This call won't do anything if @p obj is not under "pulsing mode".
17167     *
17168     * @see elm_progressbar_pulse_set() for more details.
17169     *
17170     * @ingroup Progressbar
17171     */
17172    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17173
17174    /**
17175     * Set the progress value (in percentage) on a given progress bar
17176     * widget
17177     *
17178     * @param obj The progress bar object
17179     * @param val The progress value (@b must be between @c 0.0 and @c
17180     * 1.0)
17181     *
17182     * Use this call to set progress bar levels.
17183     *
17184     * @note If you passes a value out of the specified range for @p
17185     * val, it will be interpreted as the @b closest of the @b boundary
17186     * values in the range.
17187     *
17188     * @ingroup Progressbar
17189     */
17190    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17191
17192    /**
17193     * Get the progress value (in percentage) on a given progress bar
17194     * widget
17195     *
17196     * @param obj The progress bar object
17197     * @return The value of the progressbar
17198     *
17199     * @see elm_progressbar_value_set() for more details
17200     *
17201     * @ingroup Progressbar
17202     */
17203    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17204
17205    /**
17206     * Set the label of a given progress bar widget
17207     *
17208     * @param obj The progress bar object
17209     * @param label The text label string, in UTF-8
17210     *
17211     * @ingroup Progressbar
17212     * @deprecated use elm_object_text_set() instead.
17213     */
17214    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17215
17216    /**
17217     * Get the label of a given progress bar widget
17218     *
17219     * @param obj The progressbar object
17220     * @return The text label string, in UTF-8
17221     *
17222     * @ingroup Progressbar
17223     * @deprecated use elm_object_text_set() instead.
17224     */
17225    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17226
17227    /**
17228     * Set the icon object of a given progress bar widget
17229     *
17230     * @param obj The progress bar object
17231     * @param icon The icon object
17232     *
17233     * Use this call to decorate @p obj with an icon next to it.
17234     *
17235     * @note Once the icon object is set, a previously set one will be
17236     * deleted. If you want to keep that old content object, use the
17237     * elm_progressbar_icon_unset() function.
17238     *
17239     * @see elm_progressbar_icon_get()
17240     *
17241     * @ingroup Progressbar
17242     */
17243    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17244
17245    /**
17246     * Retrieve the icon object set for a given progress bar widget
17247     *
17248     * @param obj The progress bar object
17249     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17250     * otherwise (and on errors)
17251     *
17252     * @see elm_progressbar_icon_set() for more details
17253     *
17254     * @ingroup Progressbar
17255     */
17256    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17257
17258    /**
17259     * Unset an icon set on a given progress bar widget
17260     *
17261     * @param obj The progress bar object
17262     * @return The icon object that was being used, if any was set, or
17263     * @c NULL, otherwise (and on errors)
17264     *
17265     * This call will unparent and return the icon object which was set
17266     * for this widget, previously, on success.
17267     *
17268     * @see elm_progressbar_icon_set() for more details
17269     *
17270     * @ingroup Progressbar
17271     */
17272    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17273
17274    /**
17275     * Set the (exact) length of the bar region of a given progress bar
17276     * widget
17277     *
17278     * @param obj The progress bar object
17279     * @param size The length of the progress bar's bar region
17280     *
17281     * This sets the minimum width (when in horizontal mode) or height
17282     * (when in vertical mode) of the actual bar area of the progress
17283     * bar @p obj. This in turn affects the object's minimum size. Use
17284     * this when you're not setting other size hints expanding on the
17285     * given direction (like weight and alignment hints) and you would
17286     * like it to have a specific size.
17287     *
17288     * @note Icon, label and unit text around @p obj will require their
17289     * own space, which will make @p obj to require more the @p size,
17290     * actually.
17291     *
17292     * @see elm_progressbar_span_size_get()
17293     *
17294     * @ingroup Progressbar
17295     */
17296    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17297
17298    /**
17299     * Get the length set for the bar region of a given progress bar
17300     * widget
17301     *
17302     * @param obj The progress bar object
17303     * @return The length of the progress bar's bar region
17304     *
17305     * If that size was not set previously, with
17306     * elm_progressbar_span_size_set(), this call will return @c 0.
17307     *
17308     * @ingroup Progressbar
17309     */
17310    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17311
17312    /**
17313     * Set the format string for a given progress bar widget's units
17314     * label
17315     *
17316     * @param obj The progress bar object
17317     * @param format The format string for @p obj's units label
17318     *
17319     * If @c NULL is passed on @p format, it will make @p obj's units
17320     * area to be hidden completely. If not, it'll set the <b>format
17321     * string</b> for the units label's @b text. The units label is
17322     * provided a floating point value, so the units text is up display
17323     * at most one floating point falue. Note that the units label is
17324     * optional. Use a format string such as "%1.2f meters" for
17325     * example.
17326     *
17327     * @note The default format string for a progress bar is an integer
17328     * percentage, as in @c "%.0f %%".
17329     *
17330     * @see elm_progressbar_unit_format_get()
17331     *
17332     * @ingroup Progressbar
17333     */
17334    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17335
17336    /**
17337     * Retrieve the format string set for a given progress bar widget's
17338     * units label
17339     *
17340     * @param obj The progress bar object
17341     * @return The format set string for @p obj's units label or
17342     * @c NULL, if none was set (and on errors)
17343     *
17344     * @see elm_progressbar_unit_format_set() for more details
17345     *
17346     * @ingroup Progressbar
17347     */
17348    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17349
17350    /**
17351     * Set the orientation of a given progress bar widget
17352     *
17353     * @param obj The progress bar object
17354     * @param horizontal Use @c EINA_TRUE to make @p obj to be
17355     * @b horizontal, @c EINA_FALSE to make it @b vertical
17356     *
17357     * Use this function to change how your progress bar is to be
17358     * disposed: vertically or horizontally.
17359     *
17360     * @see elm_progressbar_horizontal_get()
17361     *
17362     * @ingroup Progressbar
17363     */
17364    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17365
17366    /**
17367     * Retrieve the orientation of a given progress bar widget
17368     *
17369     * @param obj The progress bar object
17370     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17371     * @c EINA_FALSE if it's @b vertical (and on errors)
17372     *
17373     * @see elm_progressbar_horizontal_set() for more details
17374     *
17375     * @ingroup Progressbar
17376     */
17377    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17378
17379    /**
17380     * Invert a given progress bar widget's displaying values order
17381     *
17382     * @param obj The progress bar object
17383     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17384     * @c EINA_FALSE to bring it back to default, non-inverted values.
17385     *
17386     * A progress bar may be @b inverted, in which state it gets its
17387     * values inverted, with high values being on the left or top and
17388     * low values on the right or bottom, as opposed to normally have
17389     * the low values on the former and high values on the latter,
17390     * respectively, for horizontal and vertical modes.
17391     *
17392     * @see elm_progressbar_inverted_get()
17393     *
17394     * @ingroup Progressbar
17395     */
17396    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17397
17398    /**
17399     * Get whether a given progress bar widget's displaying values are
17400     * inverted or not
17401     *
17402     * @param obj The progress bar object
17403     * @return @c EINA_TRUE, if @p obj has inverted values,
17404     * @c EINA_FALSE otherwise (and on errors)
17405     *
17406     * @see elm_progressbar_inverted_set() for more details
17407     *
17408     * @ingroup Progressbar
17409     */
17410    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17411
17412    /**
17413     * @defgroup Separator Separator
17414     *
17415     * @brief Separator is a very thin object used to separate other objects.
17416     *
17417     * A separator can be vertical or horizontal.
17418     *
17419     * @ref tutorial_separator is a good example of how to use a separator.
17420     * @{
17421     */
17422    /**
17423     * @brief Add a separator object to @p parent
17424     *
17425     * @param parent The parent object
17426     *
17427     * @return The separator object, or NULL upon failure
17428     */
17429    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17430    /**
17431     * @brief Set the horizontal mode of a separator object
17432     *
17433     * @param obj The separator object
17434     * @param horizontal If true, the separator is horizontal
17435     */
17436    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17437    /**
17438     * @brief Get the horizontal mode of a separator object
17439     *
17440     * @param obj The separator object
17441     * @return If true, the separator is horizontal
17442     *
17443     * @see elm_separator_horizontal_set()
17444     */
17445    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17446    /**
17447     * @}
17448     */
17449
17450    /**
17451     * @defgroup Spinner Spinner
17452     * @ingroup Elementary
17453     *
17454     * @image html img/widget/spinner/preview-00.png
17455     * @image latex img/widget/spinner/preview-00.eps
17456     *
17457     * A spinner is a widget which allows the user to increase or decrease
17458     * numeric values using arrow buttons, or edit values directly, clicking
17459     * over it and typing the new value.
17460     *
17461     * By default the spinner will not wrap and has a label
17462     * of "%.0f" (just showing the integer value of the double).
17463     *
17464     * A spinner has a label that is formatted with floating
17465     * point values and thus accepts a printf-style format string, like
17466     * “%1.2f units”.
17467     *
17468     * It also allows specific values to be replaced by pre-defined labels.
17469     *
17470     * Smart callbacks one can register to:
17471     *
17472     * - "changed" - Whenever the spinner value is changed.
17473     * - "delay,changed" - A short time after the value is changed by the user.
17474     *    This will be called only when the user stops dragging for a very short
17475     *    period or when they release their finger/mouse, so it avoids possibly
17476     *    expensive reactions to the value change.
17477     *
17478     * Available styles for it:
17479     * - @c "default";
17480     * - @c "vertical": up/down buttons at the right side and text left aligned.
17481     *
17482     * Here is an example on its usage:
17483     * @ref spinner_example
17484     */
17485
17486    /**
17487     * @addtogroup Spinner
17488     * @{
17489     */
17490
17491    /**
17492     * Add a new spinner widget to the given parent Elementary
17493     * (container) object.
17494     *
17495     * @param parent The parent object.
17496     * @return a new spinner widget handle or @c NULL, on errors.
17497     *
17498     * This function inserts a new spinner widget on the canvas.
17499     *
17500     * @ingroup Spinner
17501     *
17502     */
17503    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17504
17505    /**
17506     * Set the format string of the displayed label.
17507     *
17508     * @param obj The spinner object.
17509     * @param fmt The format string for the label display.
17510     *
17511     * If @c NULL, this sets the format to "%.0f". If not it sets the format
17512     * string for the label text. The label text is provided a floating point
17513     * value, so the label text can display up to 1 floating point value.
17514     * Note that this is optional.
17515     *
17516     * Use a format string such as "%1.2f meters" for example, and it will
17517     * display values like: "3.14 meters" for a value equal to 3.14159.
17518     *
17519     * Default is "%0.f".
17520     *
17521     * @see elm_spinner_label_format_get()
17522     *
17523     * @ingroup Spinner
17524     */
17525    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17526
17527    /**
17528     * Get the label format of the spinner.
17529     *
17530     * @param obj The spinner object.
17531     * @return The text label format string in UTF-8.
17532     *
17533     * @see elm_spinner_label_format_set() for details.
17534     *
17535     * @ingroup Spinner
17536     */
17537    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17538
17539    /**
17540     * Set the minimum and maximum values for the spinner.
17541     *
17542     * @param obj The spinner object.
17543     * @param min The minimum value.
17544     * @param max The maximum value.
17545     *
17546     * Define the allowed range of values to be selected by the user.
17547     *
17548     * If actual value is less than @p min, it will be updated to @p min. If it
17549     * is bigger then @p max, will be updated to @p max. Actual value can be
17550     * get with elm_spinner_value_get().
17551     *
17552     * By default, min is equal to 0, and max is equal to 100.
17553     *
17554     * @warning Maximum must be greater than minimum.
17555     *
17556     * @see elm_spinner_min_max_get()
17557     *
17558     * @ingroup Spinner
17559     */
17560    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17561
17562    /**
17563     * Get the minimum and maximum values of the spinner.
17564     *
17565     * @param obj The spinner object.
17566     * @param min Pointer where to store the minimum value.
17567     * @param max Pointer where to store the maximum value.
17568     *
17569     * @note If only one value is needed, the other pointer can be passed
17570     * as @c NULL.
17571     *
17572     * @see elm_spinner_min_max_set() for details.
17573     *
17574     * @ingroup Spinner
17575     */
17576    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17577
17578    /**
17579     * Set the step used to increment or decrement the spinner value.
17580     *
17581     * @param obj The spinner object.
17582     * @param step The step value.
17583     *
17584     * This value will be incremented or decremented to the displayed value.
17585     * It will be incremented while the user keep right or top arrow pressed,
17586     * and will be decremented while the user keep left or bottom arrow pressed.
17587     *
17588     * The interval to increment / decrement can be set with
17589     * elm_spinner_interval_set().
17590     *
17591     * By default step value is equal to 1.
17592     *
17593     * @see elm_spinner_step_get()
17594     *
17595     * @ingroup Spinner
17596     */
17597    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17598
17599    /**
17600     * Get the step used to increment or decrement the spinner value.
17601     *
17602     * @param obj The spinner object.
17603     * @return The step value.
17604     *
17605     * @see elm_spinner_step_get() for more details.
17606     *
17607     * @ingroup Spinner
17608     */
17609    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17610
17611    /**
17612     * Set the value the spinner displays.
17613     *
17614     * @param obj The spinner object.
17615     * @param val The value to be displayed.
17616     *
17617     * Value will be presented on the label following format specified with
17618     * elm_spinner_format_set().
17619     *
17620     * @warning The value must to be between min and max values. This values
17621     * are set by elm_spinner_min_max_set().
17622     *
17623     * @see elm_spinner_value_get().
17624     * @see elm_spinner_format_set().
17625     * @see elm_spinner_min_max_set().
17626     *
17627     * @ingroup Spinner
17628     */
17629    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17630
17631    /**
17632     * Get the value displayed by the spinner.
17633     *
17634     * @param obj The spinner object.
17635     * @return The value displayed.
17636     *
17637     * @see elm_spinner_value_set() for details.
17638     *
17639     * @ingroup Spinner
17640     */
17641    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17642
17643    /**
17644     * Set whether the spinner should wrap when it reaches its
17645     * minimum or maximum value.
17646     *
17647     * @param obj The spinner object.
17648     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17649     * disable it.
17650     *
17651     * Disabled by default. If disabled, when the user tries to increment the
17652     * value,
17653     * but displayed value plus step value is bigger than maximum value,
17654     * the spinner
17655     * won't allow it. The same happens when the user tries to decrement it,
17656     * but the value less step is less than minimum value.
17657     *
17658     * When wrap is enabled, in such situations it will allow these changes,
17659     * but will get the value that would be less than minimum and subtracts
17660     * from maximum. Or add the value that would be more than maximum to
17661     * the minimum.
17662     *
17663     * E.g.:
17664     * @li min value = 10
17665     * @li max value = 50
17666     * @li step value = 20
17667     * @li displayed value = 20
17668     *
17669     * When the user decrement value (using left or bottom arrow), it will
17670     * displays @c 40, because max - (min - (displayed - step)) is
17671     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17672     *
17673     * @see elm_spinner_wrap_get().
17674     *
17675     * @ingroup Spinner
17676     */
17677    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17678
17679    /**
17680     * Get whether the spinner should wrap when it reaches its
17681     * minimum or maximum value.
17682     *
17683     * @param obj The spinner object
17684     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17685     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17686     *
17687     * @see elm_spinner_wrap_set() for details.
17688     *
17689     * @ingroup Spinner
17690     */
17691    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17692
17693    /**
17694     * Set whether the spinner can be directly edited by the user or not.
17695     *
17696     * @param obj The spinner object.
17697     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17698     * don't allow users to edit it directly.
17699     *
17700     * Spinner objects can have edition @b disabled, in which state they will
17701     * be changed only by arrows.
17702     * Useful for contexts
17703     * where you don't want your users to interact with it writting the value.
17704     * Specially
17705     * when using special values, the user can see real value instead
17706     * of special label on edition.
17707     *
17708     * It's enabled by default.
17709     *
17710     * @see elm_spinner_editable_get()
17711     *
17712     * @ingroup Spinner
17713     */
17714    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17715
17716    /**
17717     * Get whether the spinner can be directly edited by the user or not.
17718     *
17719     * @param obj The spinner object.
17720     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17721     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17722     *
17723     * @see elm_spinner_editable_set() for details.
17724     *
17725     * @ingroup Spinner
17726     */
17727    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17728
17729    /**
17730     * Set a special string to display in the place of the numerical value.
17731     *
17732     * @param obj The spinner object.
17733     * @param value The value to be replaced.
17734     * @param label The label to be used.
17735     *
17736     * It's useful for cases when a user should select an item that is
17737     * better indicated by a label than a value. For example, weekdays or months.
17738     *
17739     * E.g.:
17740     * @code
17741     * sp = elm_spinner_add(win);
17742     * elm_spinner_min_max_set(sp, 1, 3);
17743     * elm_spinner_special_value_add(sp, 1, "January");
17744     * elm_spinner_special_value_add(sp, 2, "February");
17745     * elm_spinner_special_value_add(sp, 3, "March");
17746     * evas_object_show(sp);
17747     * @endcode
17748     *
17749     * @ingroup Spinner
17750     */
17751    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17752
17753    /**
17754     * Set the interval on time updates for an user mouse button hold
17755     * on spinner widgets' arrows.
17756     *
17757     * @param obj The spinner object.
17758     * @param interval The (first) interval value in seconds.
17759     *
17760     * This interval value is @b decreased while the user holds the
17761     * mouse pointer either incrementing or decrementing spinner's value.
17762     *
17763     * This helps the user to get to a given value distant from the
17764     * current one easier/faster, as it will start to change quicker and
17765     * quicker on mouse button holds.
17766     *
17767     * The calculation for the next change interval value, starting from
17768     * the one set with this call, is the previous interval divided by
17769     * @c 1.05, so it decreases a little bit.
17770     *
17771     * The default starting interval value for automatic changes is
17772     * @c 0.85 seconds.
17773     *
17774     * @see elm_spinner_interval_get()
17775     *
17776     * @ingroup Spinner
17777     */
17778    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17779
17780    /**
17781     * Get the interval on time updates for an user mouse button hold
17782     * on spinner widgets' arrows.
17783     *
17784     * @param obj The spinner object.
17785     * @return The (first) interval value, in seconds, set on it.
17786     *
17787     * @see elm_spinner_interval_set() for more details.
17788     *
17789     * @ingroup Spinner
17790     */
17791    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17792
17793    /**
17794     * @}
17795     */
17796
17797    /**
17798     * @defgroup Index Index
17799     *
17800     * @image html img/widget/index/preview-00.png
17801     * @image latex img/widget/index/preview-00.eps
17802     *
17803     * An index widget gives you an index for fast access to whichever
17804     * group of other UI items one might have. It's a list of text
17805     * items (usually letters, for alphabetically ordered access).
17806     *
17807     * Index widgets are by default hidden and just appear when the
17808     * user clicks over it's reserved area in the canvas. In its
17809     * default theme, it's an area one @ref Fingers "finger" wide on
17810     * the right side of the index widget's container.
17811     *
17812     * When items on the index are selected, smart callbacks get
17813     * called, so that its user can make other container objects to
17814     * show a given area or child object depending on the index item
17815     * selected. You'd probably be using an index together with @ref
17816     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
17817     * "general grids".
17818     *
17819     * Smart events one  can add callbacks for are:
17820     * - @c "changed" - When the selected index item changes. @c
17821     *      event_info is the selected item's data pointer.
17822     * - @c "delay,changed" - When the selected index item changes, but
17823     *      after a small idling period. @c event_info is the selected
17824     *      item's data pointer.
17825     * - @c "selected" - When the user releases a mouse button and
17826     *      selects an item. @c event_info is the selected item's data
17827     *      pointer.
17828     * - @c "level,up" - when the user moves a finger from the first
17829     *      level to the second level
17830     * - @c "level,down" - when the user moves a finger from the second
17831     *      level to the first level
17832     *
17833     * The @c "delay,changed" event is so that it'll wait a small time
17834     * before actually reporting those events and, moreover, just the
17835     * last event happening on those time frames will actually be
17836     * reported.
17837     *
17838     * Here are some examples on its usage:
17839     * @li @ref index_example_01
17840     * @li @ref index_example_02
17841     */
17842
17843    /**
17844     * @addtogroup Index
17845     * @{
17846     */
17847
17848    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
17849
17850    /**
17851     * Add a new index widget to the given parent Elementary
17852     * (container) object
17853     *
17854     * @param parent The parent object
17855     * @return a new index widget handle or @c NULL, on errors
17856     *
17857     * This function inserts a new index widget on the canvas.
17858     *
17859     * @ingroup Index
17860     */
17861    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17862
17863    /**
17864     * Set whether a given index widget is or not visible,
17865     * programatically.
17866     *
17867     * @param obj The index object
17868     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
17869     *
17870     * Not to be confused with visible as in @c evas_object_show() --
17871     * visible with regard to the widget's auto hiding feature.
17872     *
17873     * @see elm_index_active_get()
17874     *
17875     * @ingroup Index
17876     */
17877    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
17878
17879    /**
17880     * Get whether a given index widget is currently visible or not.
17881     *
17882     * @param obj The index object
17883     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
17884     *
17885     * @see elm_index_active_set() for more details
17886     *
17887     * @ingroup Index
17888     */
17889    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17890
17891    /**
17892     * Set the items level for a given index widget.
17893     *
17894     * @param obj The index object.
17895     * @param level @c 0 or @c 1, the currently implemented levels.
17896     *
17897     * @see elm_index_item_level_get()
17898     *
17899     * @ingroup Index
17900     */
17901    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17902
17903    /**
17904     * Get the items level set for a given index widget.
17905     *
17906     * @param obj The index object.
17907     * @return @c 0 or @c 1, which are the levels @p obj might be at.
17908     *
17909     * @see elm_index_item_level_set() for more information
17910     *
17911     * @ingroup Index
17912     */
17913    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17914
17915    /**
17916     * Returns the last selected item's data, for a given index widget.
17917     *
17918     * @param obj The index object.
17919     * @return The item @b data associated to the last selected item on
17920     * @p obj (or @c NULL, on errors).
17921     *
17922     * @warning The returned value is @b not an #Elm_Index_Item item
17923     * handle, but the data associated to it (see the @c item parameter
17924     * in elm_index_item_append(), as an example).
17925     *
17926     * @ingroup Index
17927     */
17928    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
17929
17930    /**
17931     * Append a new item on a given index widget.
17932     *
17933     * @param obj The index object.
17934     * @param letter Letter under which the item should be indexed
17935     * @param item The item data to set for the index's item
17936     *
17937     * Despite the most common usage of the @p letter argument is for
17938     * single char strings, one could use arbitrary strings as index
17939     * entries.
17940     *
17941     * @c item will be the pointer returned back on @c "changed", @c
17942     * "delay,changed" and @c "selected" smart events.
17943     *
17944     * @ingroup Index
17945     */
17946    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17947
17948    /**
17949     * Prepend a new item on a given index widget.
17950     *
17951     * @param obj The index object.
17952     * @param letter Letter under which the item should be indexed
17953     * @param item The item data to set for the index's item
17954     *
17955     * Despite the most common usage of the @p letter argument is for
17956     * single char strings, one could use arbitrary strings as index
17957     * entries.
17958     *
17959     * @c item will be the pointer returned back on @c "changed", @c
17960     * "delay,changed" and @c "selected" smart events.
17961     *
17962     * @ingroup Index
17963     */
17964    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
17965
17966    /**
17967     * Append a new item, on a given index widget, <b>after the item
17968     * having @p relative as data</b>.
17969     *
17970     * @param obj The index object.
17971     * @param letter Letter under which the item should be indexed
17972     * @param item The item data to set for the index's item
17973     * @param relative The item data of the index item to be the
17974     * predecessor of this new one
17975     *
17976     * Despite the most common usage of the @p letter argument is for
17977     * single char strings, one could use arbitrary strings as index
17978     * entries.
17979     *
17980     * @c item will be the pointer returned back on @c "changed", @c
17981     * "delay,changed" and @c "selected" smart events.
17982     *
17983     * @note If @p relative is @c NULL or if it's not found to be data
17984     * set on any previous item on @p obj, this function will behave as
17985     * elm_index_item_append().
17986     *
17987     * @ingroup Index
17988     */
17989    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
17990
17991    /**
17992     * Prepend a new item, on a given index widget, <b>after the item
17993     * having @p relative as data</b>.
17994     *
17995     * @param obj The index object.
17996     * @param letter Letter under which the item should be indexed
17997     * @param item The item data to set for the index's item
17998     * @param relative The item data of the index item to be the
17999     * successor of this new one
18000     *
18001     * Despite the most common usage of the @p letter argument is for
18002     * single char strings, one could use arbitrary strings as index
18003     * entries.
18004     *
18005     * @c item will be the pointer returned back on @c "changed", @c
18006     * "delay,changed" and @c "selected" smart events.
18007     *
18008     * @note If @p relative is @c NULL or if it's not found to be data
18009     * set on any previous item on @p obj, this function will behave as
18010     * elm_index_item_prepend().
18011     *
18012     * @ingroup Index
18013     */
18014    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18015
18016    /**
18017     * Insert a new item into the given index widget, using @p cmp_func
18018     * function to sort items (by item handles).
18019     *
18020     * @param obj The index object.
18021     * @param letter Letter under which the item should be indexed
18022     * @param item The item data to set for the index's item
18023     * @param cmp_func The comparing function to be used to sort index
18024     * items <b>by #Elm_Index_Item item handles</b>
18025     * @param cmp_data_func A @b fallback function to be called for the
18026     * sorting of index items <b>by item data</b>). It will be used
18027     * when @p cmp_func returns @c 0 (equality), which means an index
18028     * item with provided item data already exists. To decide which
18029     * data item should be pointed to by the index item in question, @p
18030     * cmp_data_func will be used. If @p cmp_data_func returns a
18031     * non-negative value, the previous index item data will be
18032     * replaced by the given @p item pointer. If the previous data need
18033     * to be freed, it should be done by the @p cmp_data_func function,
18034     * because all references to it will be lost. If this function is
18035     * not provided (@c NULL is given), index items will be @b
18036     * duplicated, if @p cmp_func returns @c 0.
18037     *
18038     * Despite the most common usage of the @p letter argument is for
18039     * single char strings, one could use arbitrary strings as index
18040     * entries.
18041     *
18042     * @c item will be the pointer returned back on @c "changed", @c
18043     * "delay,changed" and @c "selected" smart events.
18044     *
18045     * @ingroup Index
18046     */
18047    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);
18048
18049    /**
18050     * Remove an item from a given index widget, <b>to be referenced by
18051     * it's data value</b>.
18052     *
18053     * @param obj The index object
18054     * @param item The item's data pointer for the item to be removed
18055     * from @p obj
18056     *
18057     * If a deletion callback is set, via elm_index_item_del_cb_set(),
18058     * that callback function will be called by this one.
18059     *
18060     * @warning The item to be removed from @p obj will be found via
18061     * its item data pointer, and not by an #Elm_Index_Item handle.
18062     *
18063     * @ingroup Index
18064     */
18065    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18066
18067    /**
18068     * Find a given index widget's item, <b>using item data</b>.
18069     *
18070     * @param obj The index object
18071     * @param item The item data pointed to by the desired index item
18072     * @return The index item handle, if found, or @c NULL otherwise
18073     *
18074     * @ingroup Index
18075     */
18076    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18077
18078    /**
18079     * Removes @b all items from a given index widget.
18080     *
18081     * @param obj The index object.
18082     *
18083     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
18084     * that callback function will be called for each item in @p obj.
18085     *
18086     * @ingroup Index
18087     */
18088    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18089
18090    /**
18091     * Go to a given items level on a index widget
18092     *
18093     * @param obj The index object
18094     * @param level The index level (one of @c 0 or @c 1)
18095     *
18096     * @ingroup Index
18097     */
18098    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18099
18100    /**
18101     * Return the data associated with a given index widget item
18102     *
18103     * @param it The index widget item handle
18104     * @return The data associated with @p it
18105     *
18106     * @see elm_index_item_data_set()
18107     *
18108     * @ingroup Index
18109     */
18110    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18111
18112    /**
18113     * Set the data associated with a given index widget item
18114     *
18115     * @param it The index widget item handle
18116     * @param data The new data pointer to set to @p it
18117     *
18118     * This sets new item data on @p it.
18119     *
18120     * @warning The old data pointer won't be touched by this function, so
18121     * the user had better to free that old data himself/herself.
18122     *
18123     * @ingroup Index
18124     */
18125    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18126
18127    /**
18128     * Set the function to be called when a given index widget item is freed.
18129     *
18130     * @param it The item to set the callback on
18131     * @param func The function to call on the item's deletion
18132     *
18133     * When called, @p func will have both @c data and @c event_info
18134     * arguments with the @p it item's data value and, naturally, the
18135     * @c obj argument with a handle to the parent index widget.
18136     *
18137     * @ingroup Index
18138     */
18139    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18140
18141    /**
18142     * Get the letter (string) set on a given index widget item.
18143     *
18144     * @param it The index item handle
18145     * @return The letter string set on @p it
18146     *
18147     * @ingroup Index
18148     */
18149    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18150
18151    /**
18152     * @}
18153     */
18154
18155    /**
18156     * @defgroup Photocam Photocam
18157     *
18158     * @image html img/widget/photocam/preview-00.png
18159     * @image latex img/widget/photocam/preview-00.eps
18160     *
18161     * This is a widget specifically for displaying high-resolution digital
18162     * camera photos giving speedy feedback (fast load), low memory footprint
18163     * and zooming and panning as well as fitting logic. It is entirely focused
18164     * on jpeg images, and takes advantage of properties of the jpeg format (via
18165     * evas loader features in the jpeg loader).
18166     *
18167     * Signals that you can add callbacks for are:
18168     * @li "clicked" - This is called when a user has clicked the photo without
18169     *                 dragging around.
18170     * @li "press" - This is called when a user has pressed down on the photo.
18171     * @li "longpressed" - This is called when a user has pressed down on the
18172     *                     photo for a long time without dragging around.
18173     * @li "clicked,double" - This is called when a user has double-clicked the
18174     *                        photo.
18175     * @li "load" - Photo load begins.
18176     * @li "loaded" - This is called when the image file load is complete for the
18177     *                first view (low resolution blurry version).
18178     * @li "load,detail" - Photo detailed data load begins.
18179     * @li "loaded,detail" - This is called when the image file load is complete
18180     *                      for the detailed image data (full resolution needed).
18181     * @li "zoom,start" - Zoom animation started.
18182     * @li "zoom,stop" - Zoom animation stopped.
18183     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18184     * @li "scroll" - the content has been scrolled (moved)
18185     * @li "scroll,anim,start" - scrolling animation has started
18186     * @li "scroll,anim,stop" - scrolling animation has stopped
18187     * @li "scroll,drag,start" - dragging the contents around has started
18188     * @li "scroll,drag,stop" - dragging the contents around has stopped
18189     *
18190     * @ref tutorial_photocam shows the API in action.
18191     * @{
18192     */
18193    /**
18194     * @brief Types of zoom available.
18195     */
18196    typedef enum _Elm_Photocam_Zoom_Mode
18197      {
18198         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18199         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18200         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18201         ELM_PHOTOCAM_ZOOM_MODE_LAST
18202      } Elm_Photocam_Zoom_Mode;
18203    /**
18204     * @brief Add a new Photocam object
18205     *
18206     * @param parent The parent object
18207     * @return The new object or NULL if it cannot be created
18208     */
18209    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18210    /**
18211     * @brief Set the photo file to be shown
18212     *
18213     * @param obj The photocam object
18214     * @param file The photo file
18215     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18216     *
18217     * This sets (and shows) the specified file (with a relative or absolute
18218     * path) and will return a load error (same error that
18219     * evas_object_image_load_error_get() will return). The image will change and
18220     * adjust its size at this point and begin a background load process for this
18221     * photo that at some time in the future will be displayed at the full
18222     * quality needed.
18223     */
18224    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18225    /**
18226     * @brief Returns the path of the current image file
18227     *
18228     * @param obj The photocam object
18229     * @return Returns the path
18230     *
18231     * @see elm_photocam_file_set()
18232     */
18233    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18234    /**
18235     * @brief Set the zoom level of the photo
18236     *
18237     * @param obj The photocam object
18238     * @param zoom The zoom level to set
18239     *
18240     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18241     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18242     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18243     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18244     * 16, 32, etc.).
18245     */
18246    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18247    /**
18248     * @brief Get the zoom level of the photo
18249     *
18250     * @param obj The photocam object
18251     * @return The current zoom level
18252     *
18253     * This returns the current zoom level of the photocam object. Note that if
18254     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18255     * (which is the default), the zoom level may be changed at any time by the
18256     * photocam object itself to account for photo size and photocam viewpoer
18257     * size.
18258     *
18259     * @see elm_photocam_zoom_set()
18260     * @see elm_photocam_zoom_mode_set()
18261     */
18262    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18263    /**
18264     * @brief Set the zoom mode
18265     *
18266     * @param obj The photocam object
18267     * @param mode The desired mode
18268     *
18269     * This sets the zoom mode to manual or one of several automatic levels.
18270     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18271     * elm_photocam_zoom_set() and will stay at that level until changed by code
18272     * or until zoom mode is changed. This is the default mode. The Automatic
18273     * modes will allow the photocam object to automatically adjust zoom mode
18274     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18275     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18276     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18277     * pixels within the frame are left unfilled.
18278     */
18279    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18280    /**
18281     * @brief Get the zoom mode
18282     *
18283     * @param obj The photocam object
18284     * @return The current zoom mode
18285     *
18286     * This gets the current zoom mode of the photocam object.
18287     *
18288     * @see elm_photocam_zoom_mode_set()
18289     */
18290    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18291    /**
18292     * @brief Get the current image pixel width and height
18293     *
18294     * @param obj The photocam object
18295     * @param w A pointer to the width return
18296     * @param h A pointer to the height return
18297     *
18298     * This gets the current photo pixel width and height (for the original).
18299     * The size will be returned in the integers @p w and @p h that are pointed
18300     * to.
18301     */
18302    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18303    /**
18304     * @brief Get the area of the image that is currently shown
18305     *
18306     * @param obj
18307     * @param x A pointer to the X-coordinate of region
18308     * @param y A pointer to the Y-coordinate of region
18309     * @param w A pointer to the width
18310     * @param h A pointer to the height
18311     *
18312     * @see elm_photocam_image_region_show()
18313     * @see elm_photocam_image_region_bring_in()
18314     */
18315    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18316    /**
18317     * @brief Set the viewed portion of the image
18318     *
18319     * @param obj The photocam object
18320     * @param x X-coordinate of region in image original pixels
18321     * @param y Y-coordinate of region in image original pixels
18322     * @param w Width of region in image original pixels
18323     * @param h Height of region in image original pixels
18324     *
18325     * This shows the region of the image without using animation.
18326     */
18327    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18328    /**
18329     * @brief Bring in the viewed portion of the image
18330     *
18331     * @param obj The photocam object
18332     * @param x X-coordinate of region in image original pixels
18333     * @param y Y-coordinate of region in image original pixels
18334     * @param w Width of region in image original pixels
18335     * @param h Height of region in image original pixels
18336     *
18337     * This shows the region of the image using animation.
18338     */
18339    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18340    /**
18341     * @brief Set the paused state for photocam
18342     *
18343     * @param obj The photocam object
18344     * @param paused The pause state to set
18345     *
18346     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18347     * photocam. The default is off. This will stop zooming using animation on
18348     * zoom levels changes and change instantly. This will stop any existing
18349     * animations that are running.
18350     */
18351    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18352    /**
18353     * @brief Get the paused state for photocam
18354     *
18355     * @param obj The photocam object
18356     * @return The current paused state
18357     *
18358     * This gets the current paused state for the photocam object.
18359     *
18360     * @see elm_photocam_paused_set()
18361     */
18362    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18363    /**
18364     * @brief Get the internal low-res image used for photocam
18365     *
18366     * @param obj The photocam object
18367     * @return The internal image object handle, or NULL if none exists
18368     *
18369     * This gets the internal image object inside photocam. Do not modify it. It
18370     * is for inspection only, and hooking callbacks to. Nothing else. It may be
18371     * deleted at any time as well.
18372     */
18373    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18374    /**
18375     * @brief Set the photocam scrolling bouncing.
18376     *
18377     * @param obj The photocam object
18378     * @param h_bounce bouncing for horizontal
18379     * @param v_bounce bouncing for vertical
18380     */
18381    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18382    /**
18383     * @brief Get the photocam scrolling bouncing.
18384     *
18385     * @param obj The photocam object
18386     * @param h_bounce bouncing for horizontal
18387     * @param v_bounce bouncing for vertical
18388     *
18389     * @see elm_photocam_bounce_set()
18390     */
18391    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18392    /**
18393     * @}
18394     */
18395
18396    /**
18397     * @defgroup Map Map
18398     * @ingroup Elementary
18399     *
18400     * @image html img/widget/map/preview-00.png
18401     * @image latex img/widget/map/preview-00.eps
18402     *
18403     * This is a widget specifically for displaying a map. It uses basically
18404     * OpenStreetMap provider http://www.openstreetmap.org/,
18405     * but custom providers can be added.
18406     *
18407     * It supports some basic but yet nice features:
18408     * @li zoom and scroll
18409     * @li markers with content to be displayed when user clicks over it
18410     * @li group of markers
18411     * @li routes
18412     *
18413     * Smart callbacks one can listen to:
18414     *
18415     * - "clicked" - This is called when a user has clicked the map without
18416     *   dragging around.
18417     * - "press" - This is called when a user has pressed down on the map.
18418     * - "longpressed" - This is called when a user has pressed down on the map
18419     *   for a long time without dragging around.
18420     * - "clicked,double" - This is called when a user has double-clicked
18421     *   the map.
18422     * - "load,detail" - Map detailed data load begins.
18423     * - "loaded,detail" - This is called when all currently visible parts of
18424     *   the map are loaded.
18425     * - "zoom,start" - Zoom animation started.
18426     * - "zoom,stop" - Zoom animation stopped.
18427     * - "zoom,change" - Zoom changed when using an auto zoom mode.
18428     * - "scroll" - the content has been scrolled (moved).
18429     * - "scroll,anim,start" - scrolling animation has started.
18430     * - "scroll,anim,stop" - scrolling animation has stopped.
18431     * - "scroll,drag,start" - dragging the contents around has started.
18432     * - "scroll,drag,stop" - dragging the contents around has stopped.
18433     * - "downloaded" - This is called when all currently required map images
18434     *   are downloaded.
18435     * - "route,load" - This is called when route request begins.
18436     * - "route,loaded" - This is called when route request ends.
18437     * - "name,load" - This is called when name request begins.
18438     * - "name,loaded- This is called when name request ends.
18439     *
18440     * Available style for map widget:
18441     * - @c "default"
18442     *
18443     * Available style for markers:
18444     * - @c "radio"
18445     * - @c "radio2"
18446     * - @c "empty"
18447     *
18448     * Available style for marker bubble:
18449     * - @c "default"
18450     *
18451     * List of examples:
18452     * @li @ref map_example_01
18453     * @li @ref map_example_02
18454     * @li @ref map_example_03
18455     */
18456
18457    /**
18458     * @addtogroup Map
18459     * @{
18460     */
18461
18462    /**
18463     * @enum _Elm_Map_Zoom_Mode
18464     * @typedef Elm_Map_Zoom_Mode
18465     *
18466     * Set map's zoom behavior. It can be set to manual or automatic.
18467     *
18468     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18469     *
18470     * Values <b> don't </b> work as bitmask, only one can be choosen.
18471     *
18472     * @note Valid sizes are 2^zoom, consequently the map may be smaller
18473     * than the scroller view.
18474     *
18475     * @see elm_map_zoom_mode_set()
18476     * @see elm_map_zoom_mode_get()
18477     *
18478     * @ingroup Map
18479     */
18480    typedef enum _Elm_Map_Zoom_Mode
18481      {
18482         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18483         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18484         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18485         ELM_MAP_ZOOM_MODE_LAST
18486      } Elm_Map_Zoom_Mode;
18487
18488    /**
18489     * @enum _Elm_Map_Route_Sources
18490     * @typedef Elm_Map_Route_Sources
18491     *
18492     * Set route service to be used. By default used source is
18493     * #ELM_MAP_ROUTE_SOURCE_YOURS.
18494     *
18495     * @see elm_map_route_source_set()
18496     * @see elm_map_route_source_get()
18497     *
18498     * @ingroup Map
18499     */
18500    typedef enum _Elm_Map_Route_Sources
18501      {
18502         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18503         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. */
18504         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18505         ELM_MAP_ROUTE_SOURCE_LAST
18506      } Elm_Map_Route_Sources;
18507
18508    typedef enum _Elm_Map_Name_Sources
18509      {
18510         ELM_MAP_NAME_SOURCE_NOMINATIM,
18511         ELM_MAP_NAME_SOURCE_LAST
18512      } Elm_Map_Name_Sources;
18513
18514    /**
18515     * @enum _Elm_Map_Route_Type
18516     * @typedef Elm_Map_Route_Type
18517     *
18518     * Set type of transport used on route.
18519     *
18520     * @see elm_map_route_add()
18521     *
18522     * @ingroup Map
18523     */
18524    typedef enum _Elm_Map_Route_Type
18525      {
18526         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18527         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18528         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18529         ELM_MAP_ROUTE_TYPE_LAST
18530      } Elm_Map_Route_Type;
18531
18532    /**
18533     * @enum _Elm_Map_Route_Method
18534     * @typedef Elm_Map_Route_Method
18535     *
18536     * Set the routing method, what should be priorized, time or distance.
18537     *
18538     * @see elm_map_route_add()
18539     *
18540     * @ingroup Map
18541     */
18542    typedef enum _Elm_Map_Route_Method
18543      {
18544         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18545         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18546         ELM_MAP_ROUTE_METHOD_LAST
18547      } Elm_Map_Route_Method;
18548
18549    typedef enum _Elm_Map_Name_Method
18550      {
18551         ELM_MAP_NAME_METHOD_SEARCH,
18552         ELM_MAP_NAME_METHOD_REVERSE,
18553         ELM_MAP_NAME_METHOD_LAST
18554      } Elm_Map_Name_Method;
18555
18556    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(). */
18557    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(). */
18558    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(). */
18559    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(). */
18560    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
18561    typedef struct _Elm_Map_Track           Elm_Map_Track;
18562
18563    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. */
18564    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18565    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18566    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18567
18568    typedef char        *(*ElmMapModuleSourceFunc) (void);
18569    typedef int          (*ElmMapModuleZoomMinFunc) (void);
18570    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
18571    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18572    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
18573    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18574    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18575    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18576    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18577
18578    /**
18579     * Add a new map widget to the given parent Elementary (container) object.
18580     *
18581     * @param parent The parent object.
18582     * @return a new map widget handle or @c NULL, on errors.
18583     *
18584     * This function inserts a new map widget on the canvas.
18585     *
18586     * @ingroup Map
18587     */
18588    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18589
18590    /**
18591     * Set the zoom level of the map.
18592     *
18593     * @param obj The map object.
18594     * @param zoom The zoom level to set.
18595     *
18596     * This sets the zoom level.
18597     *
18598     * It will respect limits defined by elm_map_source_zoom_min_set() and
18599     * elm_map_source_zoom_max_set().
18600     *
18601     * By default these values are 0 (world map) and 18 (maximum zoom).
18602     *
18603     * This function should be used when zoom mode is set to
18604     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18605     * with elm_map_zoom_mode_set().
18606     *
18607     * @see elm_map_zoom_mode_set().
18608     * @see elm_map_zoom_get().
18609     *
18610     * @ingroup Map
18611     */
18612    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18613
18614    /**
18615     * Get the zoom level of the map.
18616     *
18617     * @param obj The map object.
18618     * @return The current zoom level.
18619     *
18620     * This returns the current zoom level of the map object.
18621     *
18622     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18623     * (which is the default), the zoom level may be changed at any time by the
18624     * map object itself to account for map size and map viewport size.
18625     *
18626     * @see elm_map_zoom_set() for details.
18627     *
18628     * @ingroup Map
18629     */
18630    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18631
18632    /**
18633     * Set the zoom mode used by the map object.
18634     *
18635     * @param obj The map object.
18636     * @param mode The zoom mode of the map, being it one of
18637     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18638     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18639     *
18640     * This sets the zoom mode to manual or one of the automatic levels.
18641     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18642     * elm_map_zoom_set() and will stay at that level until changed by code
18643     * or until zoom mode is changed. This is the default mode.
18644     *
18645     * The Automatic modes will allow the map object to automatically
18646     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18647     * adjust zoom so the map fits inside the scroll frame with no pixels
18648     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18649     * ensure no pixels within the frame are left unfilled. Do not forget that
18650     * the valid sizes are 2^zoom, consequently the map may be smaller than
18651     * the scroller view.
18652     *
18653     * @see elm_map_zoom_set()
18654     *
18655     * @ingroup Map
18656     */
18657    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18658
18659    /**
18660     * Get the zoom mode used by the map object.
18661     *
18662     * @param obj The map object.
18663     * @return The zoom mode of the map, being it one of
18664     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18665     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18666     *
18667     * This function returns the current zoom mode used by the map object.
18668     *
18669     * @see elm_map_zoom_mode_set() for more details.
18670     *
18671     * @ingroup Map
18672     */
18673    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18674
18675    /**
18676     * Get the current coordinates of the map.
18677     *
18678     * @param obj The map object.
18679     * @param lon Pointer where to store longitude.
18680     * @param lat Pointer where to store latitude.
18681     *
18682     * This gets the current center coordinates of the map object. It can be
18683     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18684     *
18685     * @see elm_map_geo_region_bring_in()
18686     * @see elm_map_geo_region_show()
18687     *
18688     * @ingroup Map
18689     */
18690    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18691
18692    /**
18693     * Animatedly bring in given coordinates to the center of the map.
18694     *
18695     * @param obj The map object.
18696     * @param lon Longitude to center at.
18697     * @param lat Latitude to center at.
18698     *
18699     * This causes map to jump to the given @p lat and @p lon coordinates
18700     * and show it (by scrolling) in the center of the viewport, if it is not
18701     * already centered. This will use animation to do so and take a period
18702     * of time to complete.
18703     *
18704     * @see elm_map_geo_region_show() for a function to avoid animation.
18705     * @see elm_map_geo_region_get()
18706     *
18707     * @ingroup Map
18708     */
18709    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18710
18711    /**
18712     * Show the given coordinates at the center of the map, @b immediately.
18713     *
18714     * @param obj The map object.
18715     * @param lon Longitude to center at.
18716     * @param lat Latitude to center at.
18717     *
18718     * This causes map to @b redraw its viewport's contents to the
18719     * region contining the given @p lat and @p lon, that will be moved to the
18720     * center of the map.
18721     *
18722     * @see elm_map_geo_region_bring_in() for a function to move with animation.
18723     * @see elm_map_geo_region_get()
18724     *
18725     * @ingroup Map
18726     */
18727    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18728
18729    /**
18730     * Pause or unpause the map.
18731     *
18732     * @param obj The map object.
18733     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18734     * to unpause it.
18735     *
18736     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18737     * for map.
18738     *
18739     * The default is off.
18740     *
18741     * This will stop zooming using animation, changing zoom levels will
18742     * change instantly. This will stop any existing animations that are running.
18743     *
18744     * @see elm_map_paused_get()
18745     *
18746     * @ingroup Map
18747     */
18748    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18749
18750    /**
18751     * Get a value whether map is paused or not.
18752     *
18753     * @param obj The map object.
18754     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18755     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18756     *
18757     * This gets the current paused state for the map object.
18758     *
18759     * @see elm_map_paused_set() for details.
18760     *
18761     * @ingroup Map
18762     */
18763    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18764
18765    /**
18766     * Set to show markers during zoom level changes or not.
18767     *
18768     * @param obj The map object.
18769     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18770     * to show them.
18771     *
18772     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18773     * for map.
18774     *
18775     * The default is off.
18776     *
18777     * This will stop zooming using animation, changing zoom levels will
18778     * change instantly. This will stop any existing animations that are running.
18779     *
18780     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18781     * for the markers.
18782     *
18783     * The default  is off.
18784     *
18785     * Enabling it will force the map to stop displaying the markers during
18786     * zoom level changes. Set to on if you have a large number of markers.
18787     *
18788     * @see elm_map_paused_markers_get()
18789     *
18790     * @ingroup Map
18791     */
18792    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18793
18794    /**
18795     * Get a value whether markers will be displayed on zoom level changes or not
18796     *
18797     * @param obj The map object.
18798     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
18799     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
18800     *
18801     * This gets the current markers paused state for the map object.
18802     *
18803     * @see elm_map_paused_markers_set() for details.
18804     *
18805     * @ingroup Map
18806     */
18807    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18808
18809    /**
18810     * Get the information of downloading status.
18811     *
18812     * @param obj The map object.
18813     * @param try_num Pointer where to store number of tiles being downloaded.
18814     * @param finish_num Pointer where to store number of tiles successfully
18815     * downloaded.
18816     *
18817     * This gets the current downloading status for the map object, the number
18818     * of tiles being downloaded and the number of tiles already downloaded.
18819     *
18820     * @ingroup Map
18821     */
18822    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
18823
18824    /**
18825     * Convert a pixel coordinate (x,y) into a geographic coordinate
18826     * (longitude, latitude).
18827     *
18828     * @param obj The map object.
18829     * @param x the coordinate.
18830     * @param y the coordinate.
18831     * @param size the size in pixels of the map.
18832     * The map is a square and generally his size is : pow(2.0, zoom)*256.
18833     * @param lon Pointer where to store the longitude that correspond to x.
18834     * @param lat Pointer where to store the latitude that correspond to y.
18835     *
18836     * @note Origin pixel point is the top left corner of the viewport.
18837     * Map zoom and size are taken on account.
18838     *
18839     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
18840     *
18841     * @ingroup Map
18842     */
18843    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);
18844
18845    /**
18846     * Convert a geographic coordinate (longitude, latitude) into a pixel
18847     * coordinate (x, y).
18848     *
18849     * @param obj The map object.
18850     * @param lon the longitude.
18851     * @param lat the latitude.
18852     * @param size the size in pixels of the map. The map is a square
18853     * and generally his size is : pow(2.0, zoom)*256.
18854     * @param x Pointer where to store the horizontal pixel coordinate that
18855     * correspond to the longitude.
18856     * @param y Pointer where to store the vertical pixel coordinate that
18857     * correspond to the latitude.
18858     *
18859     * @note Origin pixel point is the top left corner of the viewport.
18860     * Map zoom and size are taken on account.
18861     *
18862     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
18863     *
18864     * @ingroup Map
18865     */
18866    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);
18867
18868    /**
18869     * Convert a geographic coordinate (longitude, latitude) into a name
18870     * (address).
18871     *
18872     * @param obj The map object.
18873     * @param lon the longitude.
18874     * @param lat the latitude.
18875     * @return name A #Elm_Map_Name handle for this coordinate.
18876     *
18877     * To get the string for this address, elm_map_name_address_get()
18878     * should be used.
18879     *
18880     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
18881     *
18882     * @ingroup Map
18883     */
18884    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18885
18886    /**
18887     * Convert a name (address) into a geographic coordinate
18888     * (longitude, latitude).
18889     *
18890     * @param obj The map object.
18891     * @param name The address.
18892     * @return name A #Elm_Map_Name handle for this address.
18893     *
18894     * To get the longitude and latitude, elm_map_name_region_get()
18895     * should be used.
18896     *
18897     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
18898     *
18899     * @ingroup Map
18900     */
18901    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
18902
18903    /**
18904     * Convert a pixel coordinate into a rotated pixel coordinate.
18905     *
18906     * @param obj The map object.
18907     * @param x horizontal coordinate of the point to rotate.
18908     * @param y vertical coordinate of the point to rotate.
18909     * @param cx rotation's center horizontal position.
18910     * @param cy rotation's center vertical position.
18911     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
18912     * @param xx Pointer where to store rotated x.
18913     * @param yy Pointer where to store rotated y.
18914     *
18915     * @ingroup Map
18916     */
18917    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);
18918
18919    /**
18920     * Add a new marker to the map object.
18921     *
18922     * @param obj The map object.
18923     * @param lon The longitude of the marker.
18924     * @param lat The latitude of the marker.
18925     * @param clas The class, to use when marker @b isn't grouped to others.
18926     * @param clas_group The class group, to use when marker is grouped to others
18927     * @param data The data passed to the callbacks.
18928     *
18929     * @return The created marker or @c NULL upon failure.
18930     *
18931     * A marker will be created and shown in a specific point of the map, defined
18932     * by @p lon and @p lat.
18933     *
18934     * It will be displayed using style defined by @p class when this marker
18935     * is displayed alone (not grouped). A new class can be created with
18936     * elm_map_marker_class_new().
18937     *
18938     * If the marker is grouped to other markers, it will be displayed with
18939     * style defined by @p class_group. Markers with the same group are grouped
18940     * if they are close. A new group class can be created with
18941     * elm_map_marker_group_class_new().
18942     *
18943     * Markers created with this method can be deleted with
18944     * elm_map_marker_remove().
18945     *
18946     * A marker can have associated content to be displayed by a bubble,
18947     * when a user click over it, as well as an icon. These objects will
18948     * be fetch using class' callback functions.
18949     *
18950     * @see elm_map_marker_class_new()
18951     * @see elm_map_marker_group_class_new()
18952     * @see elm_map_marker_remove()
18953     *
18954     * @ingroup Map
18955     */
18956    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);
18957
18958    /**
18959     * Set the maximum numbers of markers' content to be displayed in a group.
18960     *
18961     * @param obj The map object.
18962     * @param max The maximum numbers of items displayed in a bubble.
18963     *
18964     * A bubble will be displayed when the user clicks over the group,
18965     * and will place the content of markers that belong to this group
18966     * inside it.
18967     *
18968     * A group can have a long list of markers, consequently the creation
18969     * of the content of the bubble can be very slow.
18970     *
18971     * In order to avoid this, a maximum number of items is displayed
18972     * in a bubble.
18973     *
18974     * By default this number is 30.
18975     *
18976     * Marker with the same group class are grouped if they are close.
18977     *
18978     * @see elm_map_marker_add()
18979     *
18980     * @ingroup Map
18981     */
18982    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
18983
18984    /**
18985     * Remove a marker from the map.
18986     *
18987     * @param marker The marker to remove.
18988     *
18989     * @see elm_map_marker_add()
18990     *
18991     * @ingroup Map
18992     */
18993    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
18994
18995    /**
18996     * Get the current coordinates of the marker.
18997     *
18998     * @param marker marker.
18999     * @param lat Pointer where to store the marker's latitude.
19000     * @param lon Pointer where to store the marker's longitude.
19001     *
19002     * These values are set when adding markers, with function
19003     * elm_map_marker_add().
19004     *
19005     * @see elm_map_marker_add()
19006     *
19007     * @ingroup Map
19008     */
19009    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
19010
19011    /**
19012     * Animatedly bring in given marker to the center of the map.
19013     *
19014     * @param marker The marker to center at.
19015     *
19016     * This causes map to jump to the given @p marker's coordinates
19017     * and show it (by scrolling) in the center of the viewport, if it is not
19018     * already centered. This will use animation to do so and take a period
19019     * of time to complete.
19020     *
19021     * @see elm_map_marker_show() for a function to avoid animation.
19022     * @see elm_map_marker_region_get()
19023     *
19024     * @ingroup Map
19025     */
19026    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19027
19028    /**
19029     * Show the given marker at the center of the map, @b immediately.
19030     *
19031     * @param marker The marker to center at.
19032     *
19033     * This causes map to @b redraw its viewport's contents to the
19034     * region contining the given @p marker's coordinates, that will be
19035     * moved to the center of the map.
19036     *
19037     * @see elm_map_marker_bring_in() for a function to move with animation.
19038     * @see elm_map_markers_list_show() if more than one marker need to be
19039     * displayed.
19040     * @see elm_map_marker_region_get()
19041     *
19042     * @ingroup Map
19043     */
19044    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19045
19046    /**
19047     * Move and zoom the map to display a list of markers.
19048     *
19049     * @param markers A list of #Elm_Map_Marker handles.
19050     *
19051     * The map will be centered on the center point of the markers in the list.
19052     * Then the map will be zoomed in order to fit the markers using the maximum
19053     * zoom which allows display of all the markers.
19054     *
19055     * @warning All the markers should belong to the same map object.
19056     *
19057     * @see elm_map_marker_show() to show a single marker.
19058     * @see elm_map_marker_bring_in()
19059     *
19060     * @ingroup Map
19061     */
19062    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
19063
19064    /**
19065     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
19066     *
19067     * @param marker The marker wich content should be returned.
19068     * @return Return the evas object if it exists, else @c NULL.
19069     *
19070     * To set callback function #ElmMapMarkerGetFunc for the marker class,
19071     * elm_map_marker_class_get_cb_set() should be used.
19072     *
19073     * This content is what will be inside the bubble that will be displayed
19074     * when an user clicks over the marker.
19075     *
19076     * This returns the actual Evas object used to be placed inside
19077     * the bubble. This may be @c NULL, as it may
19078     * not have been created or may have been deleted, at any time, by
19079     * the map. <b>Do not modify this object</b> (move, resize,
19080     * show, hide, etc.), as the map is controlling it. This
19081     * function is for querying, emitting custom signals or hooking
19082     * lower level callbacks for events on that object. Do not delete
19083     * this object under any circumstances.
19084     *
19085     * @ingroup Map
19086     */
19087    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19088
19089    /**
19090     * Update the marker
19091     *
19092     * @param marker The marker to be updated.
19093     *
19094     * If a content is set to this marker, it will call function to delete it,
19095     * #ElmMapMarkerDelFunc, and then will fetch the content again with
19096     * #ElmMapMarkerGetFunc.
19097     *
19098     * These functions are set for the marker class with
19099     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19100     *
19101     * @ingroup Map
19102     */
19103    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19104
19105    /**
19106     * Close all the bubbles opened by the user.
19107     *
19108     * @param obj The map object.
19109     *
19110     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19111     * when the user clicks on a marker.
19112     *
19113     * This functions is set for the marker class with
19114     * elm_map_marker_class_get_cb_set().
19115     *
19116     * @ingroup Map
19117     */
19118    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19119
19120    /**
19121     * Create a new group class.
19122     *
19123     * @param obj The map object.
19124     * @return Returns the new group class.
19125     *
19126     * Each marker must be associated to a group class. Markers in the same
19127     * group are grouped if they are close.
19128     *
19129     * The group class defines the style of the marker when a marker is grouped
19130     * to others markers. When it is alone, another class will be used.
19131     *
19132     * A group class will need to be provided when creating a marker with
19133     * elm_map_marker_add().
19134     *
19135     * Some properties and functions can be set by class, as:
19136     * - style, with elm_map_group_class_style_set()
19137     * - data - to be associated to the group class. It can be set using
19138     *   elm_map_group_class_data_set().
19139     * - min zoom to display markers, set with
19140     *   elm_map_group_class_zoom_displayed_set().
19141     * - max zoom to group markers, set using
19142     *   elm_map_group_class_zoom_grouped_set().
19143     * - visibility - set if markers will be visible or not, set with
19144     *   elm_map_group_class_hide_set().
19145     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19146     *   It can be set using elm_map_group_class_icon_cb_set().
19147     *
19148     * @see elm_map_marker_add()
19149     * @see elm_map_group_class_style_set()
19150     * @see elm_map_group_class_data_set()
19151     * @see elm_map_group_class_zoom_displayed_set()
19152     * @see elm_map_group_class_zoom_grouped_set()
19153     * @see elm_map_group_class_hide_set()
19154     * @see elm_map_group_class_icon_cb_set()
19155     *
19156     * @ingroup Map
19157     */
19158    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19159
19160    /**
19161     * Set the marker's style of a group class.
19162     *
19163     * @param clas The group class.
19164     * @param style The style to be used by markers.
19165     *
19166     * Each marker must be associated to a group class, and will use the style
19167     * defined by such class when grouped to other markers.
19168     *
19169     * The following styles are provided by default theme:
19170     * @li @c radio - blue circle
19171     * @li @c radio2 - green circle
19172     * @li @c empty
19173     *
19174     * @see elm_map_group_class_new() for more details.
19175     * @see elm_map_marker_add()
19176     *
19177     * @ingroup Map
19178     */
19179    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19180
19181    /**
19182     * Set the icon callback function of a group class.
19183     *
19184     * @param clas The group class.
19185     * @param icon_get The callback function that will return the icon.
19186     *
19187     * Each marker must be associated to a group class, and it can display a
19188     * custom icon. The function @p icon_get must return this icon.
19189     *
19190     * @see elm_map_group_class_new() for more details.
19191     * @see elm_map_marker_add()
19192     *
19193     * @ingroup Map
19194     */
19195    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19196
19197    /**
19198     * Set the data associated to the group class.
19199     *
19200     * @param clas The group class.
19201     * @param data The new user data.
19202     *
19203     * This data will be passed for callback functions, like icon get callback,
19204     * that can be set with elm_map_group_class_icon_cb_set().
19205     *
19206     * If a data was previously set, the object will lose the pointer for it,
19207     * so if needs to be freed, you must do it yourself.
19208     *
19209     * @see elm_map_group_class_new() for more details.
19210     * @see elm_map_group_class_icon_cb_set()
19211     * @see elm_map_marker_add()
19212     *
19213     * @ingroup Map
19214     */
19215    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19216
19217    /**
19218     * Set the minimum zoom from where the markers are displayed.
19219     *
19220     * @param clas The group class.
19221     * @param zoom The minimum zoom.
19222     *
19223     * Markers only will be displayed when the map is displayed at @p zoom
19224     * or bigger.
19225     *
19226     * @see elm_map_group_class_new() for more details.
19227     * @see elm_map_marker_add()
19228     *
19229     * @ingroup Map
19230     */
19231    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19232
19233    /**
19234     * Set the zoom from where the markers are no more grouped.
19235     *
19236     * @param clas The group class.
19237     * @param zoom The maximum zoom.
19238     *
19239     * Markers only will be grouped when the map is displayed at
19240     * less than @p zoom.
19241     *
19242     * @see elm_map_group_class_new() for more details.
19243     * @see elm_map_marker_add()
19244     *
19245     * @ingroup Map
19246     */
19247    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19248
19249    /**
19250     * Set if the markers associated to the group class @clas are hidden or not.
19251     *
19252     * @param clas The group class.
19253     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19254     * to show them.
19255     *
19256     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19257     * is to show them.
19258     *
19259     * @ingroup Map
19260     */
19261    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19262
19263    /**
19264     * Create a new marker class.
19265     *
19266     * @param obj The map object.
19267     * @return Returns the new group class.
19268     *
19269     * Each marker must be associated to a class.
19270     *
19271     * The marker class defines the style of the marker when a marker is
19272     * displayed alone, i.e., not grouped to to others markers. When grouped
19273     * it will use group class style.
19274     *
19275     * A marker class will need to be provided when creating a marker with
19276     * elm_map_marker_add().
19277     *
19278     * Some properties and functions can be set by class, as:
19279     * - style, with elm_map_marker_class_style_set()
19280     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19281     *   It can be set using elm_map_marker_class_icon_cb_set().
19282     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19283     *   Set using elm_map_marker_class_get_cb_set().
19284     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19285     *   Set using elm_map_marker_class_del_cb_set().
19286     *
19287     * @see elm_map_marker_add()
19288     * @see elm_map_marker_class_style_set()
19289     * @see elm_map_marker_class_icon_cb_set()
19290     * @see elm_map_marker_class_get_cb_set()
19291     * @see elm_map_marker_class_del_cb_set()
19292     *
19293     * @ingroup Map
19294     */
19295    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19296
19297    /**
19298     * Set the marker's style of a marker class.
19299     *
19300     * @param clas The marker class.
19301     * @param style The style to be used by markers.
19302     *
19303     * Each marker must be associated to a marker class, and will use the style
19304     * defined by such class when alone, i.e., @b not grouped to other markers.
19305     *
19306     * The following styles are provided by default theme:
19307     * @li @c radio
19308     * @li @c radio2
19309     * @li @c empty
19310     *
19311     * @see elm_map_marker_class_new() for more details.
19312     * @see elm_map_marker_add()
19313     *
19314     * @ingroup Map
19315     */
19316    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19317
19318    /**
19319     * Set the icon callback function of a marker class.
19320     *
19321     * @param clas The marker class.
19322     * @param icon_get The callback function that will return the icon.
19323     *
19324     * Each marker must be associated to a marker class, and it can display a
19325     * custom icon. The function @p icon_get must return this icon.
19326     *
19327     * @see elm_map_marker_class_new() for more details.
19328     * @see elm_map_marker_add()
19329     *
19330     * @ingroup Map
19331     */
19332    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19333
19334    /**
19335     * Set the bubble content callback function of a marker class.
19336     *
19337     * @param clas The marker class.
19338     * @param get The callback function that will return the content.
19339     *
19340     * Each marker must be associated to a marker class, and it can display a
19341     * a content on a bubble that opens when the user click over the marker.
19342     * The function @p get must return this content object.
19343     *
19344     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19345     * can be used.
19346     *
19347     * @see elm_map_marker_class_new() for more details.
19348     * @see elm_map_marker_class_del_cb_set()
19349     * @see elm_map_marker_add()
19350     *
19351     * @ingroup Map
19352     */
19353    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19354
19355    /**
19356     * Set the callback function used to delete bubble content of a marker class.
19357     *
19358     * @param clas The marker class.
19359     * @param del The callback function that will delete the content.
19360     *
19361     * Each marker must be associated to a marker class, and it can display a
19362     * a content on a bubble that opens when the user click over the marker.
19363     * The function to return such content can be set with
19364     * elm_map_marker_class_get_cb_set().
19365     *
19366     * If this content must be freed, a callback function need to be
19367     * set for that task with this function.
19368     *
19369     * If this callback is defined it will have to delete (or not) the
19370     * object inside, but if the callback is not defined the object will be
19371     * destroyed with evas_object_del().
19372     *
19373     * @see elm_map_marker_class_new() for more details.
19374     * @see elm_map_marker_class_get_cb_set()
19375     * @see elm_map_marker_add()
19376     *
19377     * @ingroup Map
19378     */
19379    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19380
19381    /**
19382     * Get the list of available sources.
19383     *
19384     * @param obj The map object.
19385     * @return The source names list.
19386     *
19387     * It will provide a list with all available sources, that can be set as
19388     * current source with elm_map_source_name_set(), or get with
19389     * elm_map_source_name_get().
19390     *
19391     * Available sources:
19392     * @li "Mapnik"
19393     * @li "Osmarender"
19394     * @li "CycleMap"
19395     * @li "Maplint"
19396     *
19397     * @see elm_map_source_name_set() for more details.
19398     * @see elm_map_source_name_get()
19399     *
19400     * @ingroup Map
19401     */
19402    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19403
19404    /**
19405     * Set the source of the map.
19406     *
19407     * @param obj The map object.
19408     * @param source The source to be used.
19409     *
19410     * Map widget retrieves images that composes the map from a web service.
19411     * This web service can be set with this method.
19412     *
19413     * A different service can return a different maps with different
19414     * information and it can use different zoom values.
19415     *
19416     * The @p source_name need to match one of the names provided by
19417     * elm_map_source_names_get().
19418     *
19419     * The current source can be get using elm_map_source_name_get().
19420     *
19421     * @see elm_map_source_names_get()
19422     * @see elm_map_source_name_get()
19423     *
19424     *
19425     * @ingroup Map
19426     */
19427    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19428
19429    /**
19430     * Get the name of currently used source.
19431     *
19432     * @param obj The map object.
19433     * @return Returns the name of the source in use.
19434     *
19435     * @see elm_map_source_name_set() for more details.
19436     *
19437     * @ingroup Map
19438     */
19439    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19440
19441    /**
19442     * Set the source of the route service to be used by the map.
19443     *
19444     * @param obj The map object.
19445     * @param source The route service to be used, being it one of
19446     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19447     * and #ELM_MAP_ROUTE_SOURCE_ORS.
19448     *
19449     * Each one has its own algorithm, so the route retrieved may
19450     * differ depending on the source route. Now, only the default is working.
19451     *
19452     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19453     * http://www.yournavigation.org/.
19454     *
19455     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19456     * assumptions. Its routing core is based on Contraction Hierarchies.
19457     *
19458     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19459     *
19460     * @see elm_map_route_source_get().
19461     *
19462     * @ingroup Map
19463     */
19464    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19465
19466    /**
19467     * Get the current route source.
19468     *
19469     * @param obj The map object.
19470     * @return The source of the route service used by the map.
19471     *
19472     * @see elm_map_route_source_set() for details.
19473     *
19474     * @ingroup Map
19475     */
19476    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19477
19478    /**
19479     * Set the minimum zoom of the source.
19480     *
19481     * @param obj The map object.
19482     * @param zoom New minimum zoom value to be used.
19483     *
19484     * By default, it's 0.
19485     *
19486     * @ingroup Map
19487     */
19488    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19489
19490    /**
19491     * Get the minimum zoom of the source.
19492     *
19493     * @param obj The map object.
19494     * @return Returns the minimum zoom of the source.
19495     *
19496     * @see elm_map_source_zoom_min_set() for details.
19497     *
19498     * @ingroup Map
19499     */
19500    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19501
19502    /**
19503     * Set the maximum zoom of the source.
19504     *
19505     * @param obj The map object.
19506     * @param zoom New maximum zoom value to be used.
19507     *
19508     * By default, it's 18.
19509     *
19510     * @ingroup Map
19511     */
19512    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19513
19514    /**
19515     * Get the maximum zoom of the source.
19516     *
19517     * @param obj The map object.
19518     * @return Returns the maximum zoom of the source.
19519     *
19520     * @see elm_map_source_zoom_min_set() for details.
19521     *
19522     * @ingroup Map
19523     */
19524    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19525
19526    /**
19527     * Set the user agent used by the map object to access routing services.
19528     *
19529     * @param obj The map object.
19530     * @param user_agent The user agent to be used by the map.
19531     *
19532     * User agent is a client application implementing a network protocol used
19533     * in communications within a client–server distributed computing system
19534     *
19535     * The @p user_agent identification string will transmitted in a header
19536     * field @c User-Agent.
19537     *
19538     * @see elm_map_user_agent_get()
19539     *
19540     * @ingroup Map
19541     */
19542    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19543
19544    /**
19545     * Get the user agent used by the map object.
19546     *
19547     * @param obj The map object.
19548     * @return The user agent identification string used by the map.
19549     *
19550     * @see elm_map_user_agent_set() for details.
19551     *
19552     * @ingroup Map
19553     */
19554    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19555
19556    /**
19557     * Add a new route to the map object.
19558     *
19559     * @param obj The map object.
19560     * @param type The type of transport to be considered when tracing a route.
19561     * @param method The routing method, what should be priorized.
19562     * @param flon The start longitude.
19563     * @param flat The start latitude.
19564     * @param tlon The destination longitude.
19565     * @param tlat The destination latitude.
19566     *
19567     * @return The created route or @c NULL upon failure.
19568     *
19569     * A route will be traced by point on coordinates (@p flat, @p flon)
19570     * to point on coordinates (@p tlat, @p tlon), using the route service
19571     * set with elm_map_route_source_set().
19572     *
19573     * It will take @p type on consideration to define the route,
19574     * depending if the user will be walking or driving, the route may vary.
19575     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19576     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19577     *
19578     * Another parameter is what the route should priorize, the minor distance
19579     * or the less time to be spend on the route. So @p method should be one
19580     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19581     *
19582     * Routes created with this method can be deleted with
19583     * elm_map_route_remove(), colored with elm_map_route_color_set(),
19584     * and distance can be get with elm_map_route_distance_get().
19585     *
19586     * @see elm_map_route_remove()
19587     * @see elm_map_route_color_set()
19588     * @see elm_map_route_distance_get()
19589     * @see elm_map_route_source_set()
19590     *
19591     * @ingroup Map
19592     */
19593    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);
19594
19595    /**
19596     * Remove a route from the map.
19597     *
19598     * @param route The route to remove.
19599     *
19600     * @see elm_map_route_add()
19601     *
19602     * @ingroup Map
19603     */
19604    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19605
19606    /**
19607     * Set the route color.
19608     *
19609     * @param route The route object.
19610     * @param r Red channel value, from 0 to 255.
19611     * @param g Green channel value, from 0 to 255.
19612     * @param b Blue channel value, from 0 to 255.
19613     * @param a Alpha channel value, from 0 to 255.
19614     *
19615     * It uses an additive color model, so each color channel represents
19616     * how much of each primary colors must to be used. 0 represents
19617     * ausence of this color, so if all of the three are set to 0,
19618     * the color will be black.
19619     *
19620     * These component values should be integers in the range 0 to 255,
19621     * (single 8-bit byte).
19622     *
19623     * This sets the color used for the route. By default, it is set to
19624     * solid red (r = 255, g = 0, b = 0, a = 255).
19625     *
19626     * For alpha channel, 0 represents completely transparent, and 255, opaque.
19627     *
19628     * @see elm_map_route_color_get()
19629     *
19630     * @ingroup Map
19631     */
19632    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19633
19634    /**
19635     * Get the route color.
19636     *
19637     * @param route The route object.
19638     * @param r Pointer where to store the red channel value.
19639     * @param g Pointer where to store the green channel value.
19640     * @param b Pointer where to store the blue channel value.
19641     * @param a Pointer where to store the alpha channel value.
19642     *
19643     * @see elm_map_route_color_set() for details.
19644     *
19645     * @ingroup Map
19646     */
19647    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19648
19649    /**
19650     * Get the route distance in kilometers.
19651     *
19652     * @param route The route object.
19653     * @return The distance of route (unit : km).
19654     *
19655     * @ingroup Map
19656     */
19657    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19658
19659    /**
19660     * Get the information of route nodes.
19661     *
19662     * @param route The route object.
19663     * @return Returns a string with the nodes of route.
19664     *
19665     * @ingroup Map
19666     */
19667    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19668
19669    /**
19670     * Get the information of route waypoint.
19671     *
19672     * @param route the route object.
19673     * @return Returns a string with information about waypoint of route.
19674     *
19675     * @ingroup Map
19676     */
19677    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19678
19679    /**
19680     * Get the address of the name.
19681     *
19682     * @param name The name handle.
19683     * @return Returns the address string of @p name.
19684     *
19685     * This gets the coordinates of the @p name, created with one of the
19686     * conversion functions.
19687     *
19688     * @see elm_map_utils_convert_name_into_coord()
19689     * @see elm_map_utils_convert_coord_into_name()
19690     *
19691     * @ingroup Map
19692     */
19693    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19694
19695    /**
19696     * Get the current coordinates of the name.
19697     *
19698     * @param name The name handle.
19699     * @param lat Pointer where to store the latitude.
19700     * @param lon Pointer where to store The longitude.
19701     *
19702     * This gets the coordinates of the @p name, created with one of the
19703     * conversion functions.
19704     *
19705     * @see elm_map_utils_convert_name_into_coord()
19706     * @see elm_map_utils_convert_coord_into_name()
19707     *
19708     * @ingroup Map
19709     */
19710    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19711
19712    /**
19713     * Remove a name from the map.
19714     *
19715     * @param name The name to remove.
19716     *
19717     * Basically the struct handled by @p name will be freed, so convertions
19718     * between address and coordinates will be lost.
19719     *
19720     * @see elm_map_utils_convert_name_into_coord()
19721     * @see elm_map_utils_convert_coord_into_name()
19722     *
19723     * @ingroup Map
19724     */
19725    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19726
19727    /**
19728     * Rotate the map.
19729     *
19730     * @param obj The map object.
19731     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19732     * @param cx Rotation's center horizontal position.
19733     * @param cy Rotation's center vertical position.
19734     *
19735     * @see elm_map_rotate_get()
19736     *
19737     * @ingroup Map
19738     */
19739    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19740
19741    /**
19742     * Get the rotate degree of the map
19743     *
19744     * @param obj The map object
19745     * @param degree Pointer where to store degrees from 0.0 to 360.0
19746     * to rotate arount Z axis.
19747     * @param cx Pointer where to store rotation's center horizontal position.
19748     * @param cy Pointer where to store rotation's center vertical position.
19749     *
19750     * @see elm_map_rotate_set() to set map rotation.
19751     *
19752     * @ingroup Map
19753     */
19754    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);
19755
19756    /**
19757     * Enable or disable mouse wheel to be used to zoom in / out the map.
19758     *
19759     * @param obj The map object.
19760     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19761     * to enable it.
19762     *
19763     * Mouse wheel can be used for the user to zoom in or zoom out the map.
19764     *
19765     * It's disabled by default.
19766     *
19767     * @see elm_map_wheel_disabled_get()
19768     *
19769     * @ingroup Map
19770     */
19771    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19772
19773    /**
19774     * Get a value whether mouse wheel is enabled or not.
19775     *
19776     * @param obj The map object.
19777     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19778     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19779     *
19780     * Mouse wheel can be used for the user to zoom in or zoom out the map.
19781     *
19782     * @see elm_map_wheel_disabled_set() for details.
19783     *
19784     * @ingroup Map
19785     */
19786    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19787
19788 #ifdef ELM_EMAP
19789    /**
19790     * Add a track on the map
19791     *
19792     * @param obj The map object.
19793     * @param emap The emap route object.
19794     * @return The route object. This is an elm object of type Route.
19795     *
19796     * @see elm_route_add() for details.
19797     *
19798     * @ingroup Map
19799     */
19800    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
19801 #endif
19802
19803    /**
19804     * Remove a track from the map
19805     *
19806     * @param obj The map object.
19807     * @param route The track to remove.
19808     *
19809     * @ingroup Map
19810     */
19811    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
19812
19813    /**
19814     * @}
19815     */
19816
19817    /* Route */
19818    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
19819 #ifdef ELM_EMAP
19820    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
19821 #endif
19822    EAPI double elm_route_lon_min_get(Evas_Object *obj);
19823    EAPI double elm_route_lat_min_get(Evas_Object *obj);
19824    EAPI double elm_route_lon_max_get(Evas_Object *obj);
19825    EAPI double elm_route_lat_max_get(Evas_Object *obj);
19826
19827
19828    /**
19829     * @defgroup Panel Panel
19830     *
19831     * @image html img/widget/panel/preview-00.png
19832     * @image latex img/widget/panel/preview-00.eps
19833     *
19834     * @brief A panel is a type of animated container that contains subobjects.
19835     * It can be expanded or contracted by clicking the button on it's edge.
19836     *
19837     * Orientations are as follows:
19838     * @li ELM_PANEL_ORIENT_TOP
19839     * @li ELM_PANEL_ORIENT_LEFT
19840     * @li ELM_PANEL_ORIENT_RIGHT
19841     *
19842     * @ref tutorial_panel shows one way to use this widget.
19843     * @{
19844     */
19845    typedef enum _Elm_Panel_Orient
19846      {
19847         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
19848         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
19849         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
19850         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
19851      } Elm_Panel_Orient;
19852    /**
19853     * @brief Adds a panel object
19854     *
19855     * @param parent The parent object
19856     *
19857     * @return The panel object, or NULL on failure
19858     */
19859    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19860    /**
19861     * @brief Sets the orientation of the panel
19862     *
19863     * @param parent The parent object
19864     * @param orient The panel orientation. Can be one of the following:
19865     * @li ELM_PANEL_ORIENT_TOP
19866     * @li ELM_PANEL_ORIENT_LEFT
19867     * @li ELM_PANEL_ORIENT_RIGHT
19868     *
19869     * Sets from where the panel will (dis)appear.
19870     */
19871    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
19872    /**
19873     * @brief Get the orientation of the panel.
19874     *
19875     * @param obj The panel object
19876     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
19877     */
19878    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19879    /**
19880     * @brief Set the content of the panel.
19881     *
19882     * @param obj The panel object
19883     * @param content The panel content
19884     *
19885     * Once the content object is set, a previously set one will be deleted.
19886     * If you want to keep that old content object, use the
19887     * elm_panel_content_unset() function.
19888     */
19889    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19890    /**
19891     * @brief Get the content of the panel.
19892     *
19893     * @param obj The panel object
19894     * @return The content that is being used
19895     *
19896     * Return the content object which is set for this widget.
19897     *
19898     * @see elm_panel_content_set()
19899     */
19900    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19901    /**
19902     * @brief Unset the content of the panel.
19903     *
19904     * @param obj The panel object
19905     * @return The content that was being used
19906     *
19907     * Unparent and return the content object which was set for this widget.
19908     *
19909     * @see elm_panel_content_set()
19910     */
19911    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19912    /**
19913     * @brief Set the state of the panel.
19914     *
19915     * @param obj The panel object
19916     * @param hidden If true, the panel will run the animation to contract
19917     */
19918    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
19919    /**
19920     * @brief Get the state of the panel.
19921     *
19922     * @param obj The panel object
19923     * @param hidden If true, the panel is in the "hide" state
19924     */
19925    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19926    /**
19927     * @brief Toggle the hidden state of the panel from code
19928     *
19929     * @param obj The panel object
19930     */
19931    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
19932    /**
19933     * @}
19934     */
19935
19936    /**
19937     * @defgroup Panes Panes
19938     * @ingroup Elementary
19939     *
19940     * @image html img/widget/panes/preview-00.png
19941     * @image latex img/widget/panes/preview-00.eps width=\textwidth
19942     *
19943     * @image html img/panes.png
19944     * @image latex img/panes.eps width=\textwidth
19945     *
19946     * The panes adds a dragable bar between two contents. When dragged
19947     * this bar will resize contents size.
19948     *
19949     * Panes can be displayed vertically or horizontally, and contents
19950     * size proportion can be customized (homogeneous by default).
19951     *
19952     * Smart callbacks one can listen to:
19953     * - "press" - The panes has been pressed (button wasn't released yet).
19954     * - "unpressed" - The panes was released after being pressed.
19955     * - "clicked" - The panes has been clicked>
19956     * - "clicked,double" - The panes has been double clicked
19957     *
19958     * Available styles for it:
19959     * - @c "default"
19960     *
19961     * Here is an example on its usage:
19962     * @li @ref panes_example
19963     */
19964
19965    /**
19966     * @addtogroup Panes
19967     * @{
19968     */
19969
19970    /**
19971     * Add a new panes widget to the given parent Elementary
19972     * (container) object.
19973     *
19974     * @param parent The parent object.
19975     * @return a new panes widget handle or @c NULL, on errors.
19976     *
19977     * This function inserts a new panes widget on the canvas.
19978     *
19979     * @ingroup Panes
19980     */
19981    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19982
19983    /**
19984     * Set the left content of the panes widget.
19985     *
19986     * @param obj The panes object.
19987     * @param content The new left content object.
19988     *
19989     * Once the content object is set, a previously set one will be deleted.
19990     * If you want to keep that old content object, use the
19991     * elm_panes_content_left_unset() function.
19992     *
19993     * If panes is displayed vertically, left content will be displayed at
19994     * top.
19995     *
19996     * @see elm_panes_content_left_get()
19997     * @see elm_panes_content_right_set() to set content on the other side.
19998     *
19999     * @ingroup Panes
20000     */
20001    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20002
20003    /**
20004     * Set the right content of the panes widget.
20005     *
20006     * @param obj The panes object.
20007     * @param content The new right content object.
20008     *
20009     * Once the content object is set, a previously set one will be deleted.
20010     * If you want to keep that old content object, use the
20011     * elm_panes_content_right_unset() function.
20012     *
20013     * If panes is displayed vertically, left content will be displayed at
20014     * bottom.
20015     *
20016     * @see elm_panes_content_right_get()
20017     * @see elm_panes_content_left_set() to set content on the other side.
20018     *
20019     * @ingroup Panes
20020     */
20021    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20022
20023    /**
20024     * Get the left content of the panes.
20025     *
20026     * @param obj The panes object.
20027     * @return The left content object that is being used.
20028     *
20029     * Return the left content object which is set for this widget.
20030     *
20031     * @see elm_panes_content_left_set() for details.
20032     *
20033     * @ingroup Panes
20034     */
20035    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20036
20037    /**
20038     * Get the right content of the panes.
20039     *
20040     * @param obj The panes object
20041     * @return The right content object that is being used
20042     *
20043     * Return the right content object which is set for this widget.
20044     *
20045     * @see elm_panes_content_right_set() for details.
20046     *
20047     * @ingroup Panes
20048     */
20049    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20050
20051    /**
20052     * Unset the left content used for the panes.
20053     *
20054     * @param obj The panes object.
20055     * @return The left content object that was being used.
20056     *
20057     * Unparent and return the left content object which was set for this widget.
20058     *
20059     * @see elm_panes_content_left_set() for details.
20060     * @see elm_panes_content_left_get().
20061     *
20062     * @ingroup Panes
20063     */
20064    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20065
20066    /**
20067     * Unset the right content used for the panes.
20068     *
20069     * @param obj The panes object.
20070     * @return The right content object that was being used.
20071     *
20072     * Unparent and return the right content object which was set for this
20073     * widget.
20074     *
20075     * @see elm_panes_content_right_set() for details.
20076     * @see elm_panes_content_right_get().
20077     *
20078     * @ingroup Panes
20079     */
20080    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20081
20082    /**
20083     * Get the size proportion of panes widget's left side.
20084     *
20085     * @param obj The panes object.
20086     * @return float value between 0.0 and 1.0 representing size proportion
20087     * of left side.
20088     *
20089     * @see elm_panes_content_left_size_set() for more details.
20090     *
20091     * @ingroup Panes
20092     */
20093    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20094
20095    /**
20096     * Set the size proportion of panes widget's left side.
20097     *
20098     * @param obj The panes object.
20099     * @param size Value between 0.0 and 1.0 representing size proportion
20100     * of left side.
20101     *
20102     * By default it's homogeneous, i.e., both sides have the same size.
20103     *
20104     * If something different is required, it can be set with this function.
20105     * For example, if the left content should be displayed over
20106     * 75% of the panes size, @p size should be passed as @c 0.75.
20107     * This way, right content will be resized to 25% of panes size.
20108     *
20109     * If displayed vertically, left content is displayed at top, and
20110     * right content at bottom.
20111     *
20112     * @note This proportion will change when user drags the panes bar.
20113     *
20114     * @see elm_panes_content_left_size_get()
20115     *
20116     * @ingroup Panes
20117     */
20118    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20119
20120   /**
20121    * Set the orientation of a given panes widget.
20122    *
20123    * @param obj The panes object.
20124    * @param horizontal Use @c EINA_TRUE to make @p obj to be
20125    * @b horizontal, @c EINA_FALSE to make it @b vertical.
20126    *
20127    * Use this function to change how your panes is to be
20128    * disposed: vertically or horizontally.
20129    *
20130    * By default it's displayed horizontally.
20131    *
20132    * @see elm_panes_horizontal_get()
20133    *
20134    * @ingroup Panes
20135    */
20136    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20137
20138    /**
20139     * Retrieve the orientation of a given panes widget.
20140     *
20141     * @param obj The panes object.
20142     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20143     * @c EINA_FALSE if it's @b vertical (and on errors).
20144     *
20145     * @see elm_panes_horizontal_set() for more details.
20146     *
20147     * @ingroup Panes
20148     */
20149    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20150
20151    /**
20152     * @}
20153     */
20154
20155    /**
20156     * @defgroup Flip Flip
20157     *
20158     * @image html img/widget/flip/preview-00.png
20159     * @image latex img/widget/flip/preview-00.eps
20160     *
20161     * This widget holds 2 content objects(Evas_Object): one on the front and one
20162     * on the back. It allows you to flip from front to back and vice-versa using
20163     * various animations.
20164     *
20165     * If either the front or back contents are not set the flip will treat that
20166     * as transparent. So if you wore to set the front content but not the back,
20167     * and then call elm_flip_go() you would see whatever is below the flip.
20168     *
20169     * For a list of supported animations see elm_flip_go().
20170     *
20171     * Signals that you can add callbacks for are:
20172     * "animate,begin" - when a flip animation was started
20173     * "animate,done" - when a flip animation is finished
20174     *
20175     * @ref tutorial_flip show how to use most of the API.
20176     *
20177     * @{
20178     */
20179    typedef enum _Elm_Flip_Mode
20180      {
20181         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20182         ELM_FLIP_ROTATE_X_CENTER_AXIS,
20183         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20184         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20185         ELM_FLIP_CUBE_LEFT,
20186         ELM_FLIP_CUBE_RIGHT,
20187         ELM_FLIP_CUBE_UP,
20188         ELM_FLIP_CUBE_DOWN,
20189         ELM_FLIP_PAGE_LEFT,
20190         ELM_FLIP_PAGE_RIGHT,
20191         ELM_FLIP_PAGE_UP,
20192         ELM_FLIP_PAGE_DOWN
20193      } Elm_Flip_Mode;
20194    typedef enum _Elm_Flip_Interaction
20195      {
20196         ELM_FLIP_INTERACTION_NONE,
20197         ELM_FLIP_INTERACTION_ROTATE,
20198         ELM_FLIP_INTERACTION_CUBE,
20199         ELM_FLIP_INTERACTION_PAGE
20200      } Elm_Flip_Interaction;
20201    typedef enum _Elm_Flip_Direction
20202      {
20203         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20204         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20205         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20206         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20207      } Elm_Flip_Direction;
20208    /**
20209     * @brief Add a new flip to the parent
20210     *
20211     * @param parent The parent object
20212     * @return The new object or NULL if it cannot be created
20213     */
20214    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20215    /**
20216     * @brief Set the front content of the flip widget.
20217     *
20218     * @param obj The flip object
20219     * @param content The new front content object
20220     *
20221     * Once the content object is set, a previously set one will be deleted.
20222     * If you want to keep that old content object, use the
20223     * elm_flip_content_front_unset() function.
20224     */
20225    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20226    /**
20227     * @brief Set the back content of the flip widget.
20228     *
20229     * @param obj The flip object
20230     * @param content The new back content object
20231     *
20232     * Once the content object is set, a previously set one will be deleted.
20233     * If you want to keep that old content object, use the
20234     * elm_flip_content_back_unset() function.
20235     */
20236    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20237    /**
20238     * @brief Get the front content used for the flip
20239     *
20240     * @param obj The flip object
20241     * @return The front content object that is being used
20242     *
20243     * Return the front content object which is set for this widget.
20244     */
20245    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20246    /**
20247     * @brief Get the back content used for the flip
20248     *
20249     * @param obj The flip object
20250     * @return The back content object that is being used
20251     *
20252     * Return the back content object which is set for this widget.
20253     */
20254    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20255    /**
20256     * @brief Unset the front content used for the flip
20257     *
20258     * @param obj The flip object
20259     * @return The front content object that was being used
20260     *
20261     * Unparent and return the front content object which was set for this widget.
20262     */
20263    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20264    /**
20265     * @brief Unset the back content used for the flip
20266     *
20267     * @param obj The flip object
20268     * @return The back content object that was being used
20269     *
20270     * Unparent and return the back content object which was set for this widget.
20271     */
20272    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20273    /**
20274     * @brief Get flip front visibility state
20275     *
20276     * @param obj The flip objct
20277     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20278     * showing.
20279     */
20280    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20281    /**
20282     * @brief Set flip perspective
20283     *
20284     * @param obj The flip object
20285     * @param foc The coordinate to set the focus on
20286     * @param x The X coordinate
20287     * @param y The Y coordinate
20288     *
20289     * @warning This function currently does nothing.
20290     */
20291    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20292    /**
20293     * @brief Runs the flip animation
20294     *
20295     * @param obj The flip object
20296     * @param mode The mode type
20297     *
20298     * Flips the front and back contents using the @p mode animation. This
20299     * efectively hides the currently visible content and shows the hidden one.
20300     *
20301     * There a number of possible animations to use for the flipping:
20302     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20303     * around a horizontal axis in the middle of its height, the other content
20304     * is shown as the other side of the flip.
20305     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20306     * around a vertical axis in the middle of its width, the other content is
20307     * shown as the other side of the flip.
20308     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20309     * around a diagonal axis in the middle of its width, the other content is
20310     * shown as the other side of the flip.
20311     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20312     * around a diagonal axis in the middle of its height, the other content is
20313     * shown as the other side of the flip.
20314     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20315     * as if the flip was a cube, the other content is show as the right face of
20316     * the cube.
20317     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20318     * right as if the flip was a cube, the other content is show as the left
20319     * face of the cube.
20320     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20321     * flip was a cube, the other content is show as the bottom face of the cube.
20322     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20323     * the flip was a cube, the other content is show as the upper face of the
20324     * cube.
20325     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20326     * if the flip was a book, the other content is shown as the page below that.
20327     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20328     * as if the flip was a book, the other content is shown as the page below
20329     * that.
20330     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20331     * flip was a book, the other content is shown as the page below that.
20332     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20333     * flip was a book, the other content is shown as the page below that.
20334     *
20335     * @image html elm_flip.png
20336     * @image latex elm_flip.eps width=\textwidth
20337     */
20338    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20339    /**
20340     * @brief Set the interactive flip mode
20341     *
20342     * @param obj The flip object
20343     * @param mode The interactive flip mode to use
20344     *
20345     * This sets if the flip should be interactive (allow user to click and
20346     * drag a side of the flip to reveal the back page and cause it to flip).
20347     * By default a flip is not interactive. You may also need to set which
20348     * sides of the flip are "active" for flipping and how much space they use
20349     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20350     * and elm_flip_interacton_direction_hitsize_set()
20351     *
20352     * The four avilable mode of interaction are:
20353     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20354     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20355     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20356     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20357     *
20358     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20359     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20360     * happen, those can only be acheived with elm_flip_go();
20361     */
20362    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20363    /**
20364     * @brief Get the interactive flip mode
20365     *
20366     * @param obj The flip object
20367     * @return The interactive flip mode
20368     *
20369     * Returns the interactive flip mode set by elm_flip_interaction_set()
20370     */
20371    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20372    /**
20373     * @brief Set which directions of the flip respond to interactive flip
20374     *
20375     * @param obj The flip object
20376     * @param dir The direction to change
20377     * @param enabled If that direction is enabled or not
20378     *
20379     * By default all directions are disabled, so you may want to enable the
20380     * desired directions for flipping if you need interactive flipping. You must
20381     * call this function once for each direction that should be enabled.
20382     *
20383     * @see elm_flip_interaction_set()
20384     */
20385    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20386    /**
20387     * @brief Get the enabled state of that flip direction
20388     *
20389     * @param obj The flip object
20390     * @param dir The direction to check
20391     * @return If that direction is enabled or not
20392     *
20393     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20394     *
20395     * @see elm_flip_interaction_set()
20396     */
20397    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20398    /**
20399     * @brief Set the amount of the flip that is sensitive to interactive flip
20400     *
20401     * @param obj The flip object
20402     * @param dir The direction to modify
20403     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20404     *
20405     * Set the amount of the flip that is sensitive to interactive flip, with 0
20406     * representing no area in the flip and 1 representing the entire flip. There
20407     * is however a consideration to be made in that the area will never be
20408     * smaller than the finger size set(as set in your Elementary configuration).
20409     *
20410     * @see elm_flip_interaction_set()
20411     */
20412    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20413    /**
20414     * @brief Get the amount of the flip that is sensitive to interactive flip
20415     *
20416     * @param obj The flip object
20417     * @param dir The direction to check
20418     * @return The size set for that direction
20419     *
20420     * Returns the amount os sensitive area set by
20421     * elm_flip_interacton_direction_hitsize_set().
20422     */
20423    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20424    /**
20425     * @}
20426     */
20427
20428    /* scrolledentry */
20429    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20430    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20431    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20432    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20433    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20434    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20435    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20436    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20437    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20438    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20439    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20440    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20441    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20442    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20443    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20444    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20445    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20446    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20447    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20448    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20449    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20450    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20451    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20452    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20453    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20454    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20455    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20456    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20457    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20458    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20459    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20460    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20461    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20462    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20463    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20464    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);
20465    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20466    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20467    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);
20468    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20469    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);
20470    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20471    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20472    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20473    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20474    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20475    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20476    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20477    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20478    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);
20479    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);
20480    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);
20481    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);
20482    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);
20483    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);
20484    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20485    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20486    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20487    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20488    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20489    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20490    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20491
20492    /**
20493     * @defgroup Conformant Conformant
20494     * @ingroup Elementary
20495     *
20496     * @image html img/widget/conformant/preview-00.png
20497     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20498     *
20499     * @image html img/conformant.png
20500     * @image latex img/conformant.eps width=\textwidth
20501     *
20502     * The aim is to provide a widget that can be used in elementary apps to
20503     * account for space taken up by the indicator, virtual keypad & softkey
20504     * windows when running the illume2 module of E17.
20505     *
20506     * So conformant content will be sized and positioned considering the
20507     * space required for such stuff, and when they popup, as a keyboard
20508     * shows when an entry is selected, conformant content won't change.
20509     *
20510     * Available styles for it:
20511     * - @c "default"
20512     *
20513     * See how to use this widget in this example:
20514     * @ref conformant_example
20515     */
20516
20517    /**
20518     * @addtogroup Conformant
20519     * @{
20520     */
20521
20522    /**
20523     * Add a new conformant widget to the given parent Elementary
20524     * (container) object.
20525     *
20526     * @param parent The parent object.
20527     * @return A new conformant widget handle or @c NULL, on errors.
20528     *
20529     * This function inserts a new conformant widget on the canvas.
20530     *
20531     * @ingroup Conformant
20532     */
20533    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20534
20535    /**
20536     * Set the content of the conformant widget.
20537     *
20538     * @param obj The conformant object.
20539     * @param content The content to be displayed by the conformant.
20540     *
20541     * Content will be sized and positioned considering the space required
20542     * to display a virtual keyboard. So it won't fill all the conformant
20543     * size. This way is possible to be sure that content won't resize
20544     * or be re-positioned after the keyboard is displayed.
20545     *
20546     * Once the content object is set, a previously set one will be deleted.
20547     * If you want to keep that old content object, use the
20548     * elm_conformat_content_unset() function.
20549     *
20550     * @see elm_conformant_content_unset()
20551     * @see elm_conformant_content_get()
20552     *
20553     * @ingroup Conformant
20554     */
20555    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20556
20557    /**
20558     * Get the content of the conformant widget.
20559     *
20560     * @param obj The conformant object.
20561     * @return The content that is being used.
20562     *
20563     * Return the content object which is set for this widget.
20564     * It won't be unparent from conformant. For that, use
20565     * elm_conformant_content_unset().
20566     *
20567     * @see elm_conformant_content_set() for more details.
20568     * @see elm_conformant_content_unset()
20569     *
20570     * @ingroup Conformant
20571     */
20572    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20573
20574    /**
20575     * Unset the content of the conformant widget.
20576     *
20577     * @param obj The conformant object.
20578     * @return The content that was being used.
20579     *
20580     * Unparent and return the content object which was set for this widget.
20581     *
20582     * @see elm_conformant_content_set() for more details.
20583     *
20584     * @ingroup Conformant
20585     */
20586    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20587
20588    /**
20589     * Returns the Evas_Object that represents the content area.
20590     *
20591     * @param obj The conformant object.
20592     * @return The content area of the widget.
20593     *
20594     * @ingroup Conformant
20595     */
20596    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20597
20598    /**
20599     * @}
20600     */
20601
20602    /**
20603     * @defgroup Mapbuf Mapbuf
20604     * @ingroup Elementary
20605     *
20606     * @image html img/widget/mapbuf/preview-00.png
20607     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20608     *
20609     * This holds one content object and uses an Evas Map of transformation
20610     * points to be later used with this content. So the content will be
20611     * moved, resized, etc as a single image. So it will improve performance
20612     * when you have a complex interafce, with a lot of elements, and will
20613     * need to resize or move it frequently (the content object and its
20614     * children).
20615     *
20616     * See how to use this widget in this example:
20617     * @ref mapbuf_example
20618     */
20619
20620    /**
20621     * @addtogroup Mapbuf
20622     * @{
20623     */
20624
20625    /**
20626     * Add a new mapbuf widget to the given parent Elementary
20627     * (container) object.
20628     *
20629     * @param parent The parent object.
20630     * @return A new mapbuf widget handle or @c NULL, on errors.
20631     *
20632     * This function inserts a new mapbuf widget on the canvas.
20633     *
20634     * @ingroup Mapbuf
20635     */
20636    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20637
20638    /**
20639     * Set the content of the mapbuf.
20640     *
20641     * @param obj The mapbuf object.
20642     * @param content The content that will be filled in this mapbuf object.
20643     *
20644     * Once the content object is set, a previously set one will be deleted.
20645     * If you want to keep that old content object, use the
20646     * elm_mapbuf_content_unset() function.
20647     *
20648     * To enable map, elm_mapbuf_enabled_set() should be used.
20649     *
20650     * @ingroup Mapbuf
20651     */
20652    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20653
20654    /**
20655     * Get the content of the mapbuf.
20656     *
20657     * @param obj The mapbuf object.
20658     * @return The content that is being used.
20659     *
20660     * Return the content object which is set for this widget.
20661     *
20662     * @see elm_mapbuf_content_set() for details.
20663     *
20664     * @ingroup Mapbuf
20665     */
20666    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20667
20668    /**
20669     * Unset the content of the mapbuf.
20670     *
20671     * @param obj The mapbuf object.
20672     * @return The content that was being used.
20673     *
20674     * Unparent and return the content object which was set for this widget.
20675     *
20676     * @see elm_mapbuf_content_set() for details.
20677     *
20678     * @ingroup Mapbuf
20679     */
20680    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20681
20682    /**
20683     * Enable or disable the map.
20684     *
20685     * @param obj The mapbuf object.
20686     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20687     *
20688     * This enables the map that is set or disables it. On enable, the object
20689     * geometry will be saved, and the new geometry will change (position and
20690     * size) to reflect the map geometry set.
20691     *
20692     * Also, when enabled, alpha and smooth states will be used, so if the
20693     * content isn't solid, alpha should be enabled, for example, otherwise
20694     * a black retangle will fill the content.
20695     *
20696     * When disabled, the stored map will be freed and geometry prior to
20697     * enabling the map will be restored.
20698     *
20699     * It's disabled by default.
20700     *
20701     * @see elm_mapbuf_alpha_set()
20702     * @see elm_mapbuf_smooth_set()
20703     *
20704     * @ingroup Mapbuf
20705     */
20706    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20707
20708    /**
20709     * Get a value whether map is enabled or not.
20710     *
20711     * @param obj The mapbuf object.
20712     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20713     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20714     *
20715     * @see elm_mapbuf_enabled_set() for details.
20716     *
20717     * @ingroup Mapbuf
20718     */
20719    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20720
20721    /**
20722     * Enable or disable smooth map rendering.
20723     *
20724     * @param obj The mapbuf object.
20725     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20726     * to disable it.
20727     *
20728     * This sets smoothing for map rendering. If the object is a type that has
20729     * its own smoothing settings, then both the smooth settings for this object
20730     * and the map must be turned off.
20731     *
20732     * By default smooth maps are enabled.
20733     *
20734     * @ingroup Mapbuf
20735     */
20736    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20737
20738    /**
20739     * Get a value whether smooth map rendering is enabled or not.
20740     *
20741     * @param obj The mapbuf object.
20742     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20743     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20744     *
20745     * @see elm_mapbuf_smooth_set() for details.
20746     *
20747     * @ingroup Mapbuf
20748     */
20749    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20750
20751    /**
20752     * Set or unset alpha flag for map rendering.
20753     *
20754     * @param obj The mapbuf object.
20755     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20756     * to disable it.
20757     *
20758     * This sets alpha flag for map rendering. If the object is a type that has
20759     * its own alpha settings, then this will take precedence. Only image objects
20760     * have this currently. It stops alpha blending of the map area, and is
20761     * useful if you know the object and/or all sub-objects is 100% solid.
20762     *
20763     * Alpha is enabled by default.
20764     *
20765     * @ingroup Mapbuf
20766     */
20767    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20768
20769    /**
20770     * Get a value whether alpha blending is enabled or not.
20771     *
20772     * @param obj The mapbuf object.
20773     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20774     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20775     *
20776     * @see elm_mapbuf_alpha_set() for details.
20777     *
20778     * @ingroup Mapbuf
20779     */
20780    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20781
20782    /**
20783     * @}
20784     */
20785
20786    /**
20787     * @defgroup Flipselector Flip Selector
20788     *
20789     * @image html img/widget/flipselector/preview-00.png
20790     * @image latex img/widget/flipselector/preview-00.eps
20791     *
20792     * A flip selector is a widget to show a set of @b text items, one
20793     * at a time, with the same sheet switching style as the @ref Clock
20794     * "clock" widget, when one changes the current displaying sheet
20795     * (thus, the "flip" in the name).
20796     *
20797     * User clicks to flip sheets which are @b held for some time will
20798     * make the flip selector to flip continuosly and automatically for
20799     * the user. The interval between flips will keep growing in time,
20800     * so that it helps the user to reach an item which is distant from
20801     * the current selection.
20802     *
20803     * Smart callbacks one can register to:
20804     * - @c "selected" - when the widget's selected text item is changed
20805     * - @c "overflowed" - when the widget's current selection is changed
20806     *   from the first item in its list to the last
20807     * - @c "underflowed" - when the widget's current selection is changed
20808     *   from the last item in its list to the first
20809     *
20810     * Available styles for it:
20811     * - @c "default"
20812     *
20813     * Here is an example on its usage:
20814     * @li @ref flipselector_example
20815     */
20816
20817    /**
20818     * @addtogroup Flipselector
20819     * @{
20820     */
20821
20822    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
20823
20824    /**
20825     * Add a new flip selector widget to the given parent Elementary
20826     * (container) widget
20827     *
20828     * @param parent The parent object
20829     * @return a new flip selector widget handle or @c NULL, on errors
20830     *
20831     * This function inserts a new flip selector widget on the canvas.
20832     *
20833     * @ingroup Flipselector
20834     */
20835    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20836
20837    /**
20838     * Programmatically select the next item of a flip selector widget
20839     *
20840     * @param obj The flipselector object
20841     *
20842     * @note The selection will be animated. Also, if it reaches the
20843     * end of its list of member items, it will continue with the first
20844     * one onwards.
20845     *
20846     * @ingroup Flipselector
20847     */
20848    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20849
20850    /**
20851     * Programmatically select the previous item of a flip selector
20852     * widget
20853     *
20854     * @param obj The flipselector object
20855     *
20856     * @note The selection will be animated.  Also, if it reaches the
20857     * beginning of its list of member items, it will continue with the
20858     * last one backwards.
20859     *
20860     * @ingroup Flipselector
20861     */
20862    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20863
20864    /**
20865     * Append a (text) item to a flip selector widget
20866     *
20867     * @param obj The flipselector object
20868     * @param label The (text) label of the new item
20869     * @param func Convenience callback function to take place when
20870     * item is selected
20871     * @param data Data passed to @p func, above
20872     * @return A handle to the item added or @c NULL, on errors
20873     *
20874     * The widget's list of labels to show will be appended with the
20875     * given value. If the user wishes so, a callback function pointer
20876     * can be passed, which will get called when this same item is
20877     * selected.
20878     *
20879     * @note The current selection @b won't be modified by appending an
20880     * element to the list.
20881     *
20882     * @note The maximum length of the text label is going to be
20883     * determined <b>by the widget's theme</b>. Strings larger than
20884     * that value are going to be @b truncated.
20885     *
20886     * @ingroup Flipselector
20887     */
20888    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20889
20890    /**
20891     * Prepend a (text) item to a flip selector widget
20892     *
20893     * @param obj The flipselector object
20894     * @param label The (text) label of the new item
20895     * @param func Convenience callback function to take place when
20896     * item is selected
20897     * @param data Data passed to @p func, above
20898     * @return A handle to the item added or @c NULL, on errors
20899     *
20900     * The widget's list of labels to show will be prepended with the
20901     * given value. If the user wishes so, a callback function pointer
20902     * can be passed, which will get called when this same item is
20903     * selected.
20904     *
20905     * @note The current selection @b won't be modified by prepending
20906     * an element to the list.
20907     *
20908     * @note The maximum length of the text label is going to be
20909     * determined <b>by the widget's theme</b>. Strings larger than
20910     * that value are going to be @b truncated.
20911     *
20912     * @ingroup Flipselector
20913     */
20914    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
20915
20916    /**
20917     * Get the internal list of items in a given flip selector widget.
20918     *
20919     * @param obj The flipselector object
20920     * @return The list of items (#Elm_Flipselector_Item as data) or
20921     * @c NULL on errors.
20922     *
20923     * This list is @b not to be modified in any way and must not be
20924     * freed. Use the list members with functions like
20925     * elm_flipselector_item_label_set(),
20926     * elm_flipselector_item_label_get(),
20927     * elm_flipselector_item_del(),
20928     * elm_flipselector_item_selected_get(),
20929     * elm_flipselector_item_selected_set().
20930     *
20931     * @warning This list is only valid until @p obj object's internal
20932     * items list is changed. It should be fetched again with another
20933     * call to this function when changes happen.
20934     *
20935     * @ingroup Flipselector
20936     */
20937    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20938
20939    /**
20940     * Get the first item in the given flip selector widget's list of
20941     * items.
20942     *
20943     * @param obj The flipselector object
20944     * @return The first item or @c NULL, if it has no items (and on
20945     * errors)
20946     *
20947     * @see elm_flipselector_item_append()
20948     * @see elm_flipselector_last_item_get()
20949     *
20950     * @ingroup Flipselector
20951     */
20952    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20953
20954    /**
20955     * Get the last item in the given flip selector widget's list of
20956     * items.
20957     *
20958     * @param obj The flipselector object
20959     * @return The last item or @c NULL, if it has no items (and on
20960     * errors)
20961     *
20962     * @see elm_flipselector_item_prepend()
20963     * @see elm_flipselector_first_item_get()
20964     *
20965     * @ingroup Flipselector
20966     */
20967    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20968
20969    /**
20970     * Get the currently selected item in a flip selector widget.
20971     *
20972     * @param obj The flipselector object
20973     * @return The selected item or @c NULL, if the widget has no items
20974     * (and on erros)
20975     *
20976     * @ingroup Flipselector
20977     */
20978    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20979
20980    /**
20981     * Set whether a given flip selector widget's item should be the
20982     * currently selected one.
20983     *
20984     * @param item The flip selector item
20985     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
20986     *
20987     * This sets whether @p item is or not the selected (thus, under
20988     * display) one. If @p item is different than one under display,
20989     * the latter will be unselected. If the @p item is set to be
20990     * unselected, on the other hand, the @b first item in the widget's
20991     * internal members list will be the new selected one.
20992     *
20993     * @see elm_flipselector_item_selected_get()
20994     *
20995     * @ingroup Flipselector
20996     */
20997    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20998
20999    /**
21000     * Get whether a given flip selector widget's item is the currently
21001     * selected one.
21002     *
21003     * @param item The flip selector item
21004     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
21005     * (or on errors).
21006     *
21007     * @see elm_flipselector_item_selected_set()
21008     *
21009     * @ingroup Flipselector
21010     */
21011    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21012
21013    /**
21014     * Delete a given item from a flip selector widget.
21015     *
21016     * @param item The item to delete
21017     *
21018     * @ingroup Flipselector
21019     */
21020    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21021
21022    /**
21023     * Get the label of a given flip selector widget's item.
21024     *
21025     * @param item The item to get label from
21026     * @return The text label of @p item or @c NULL, on errors
21027     *
21028     * @see elm_flipselector_item_label_set()
21029     *
21030     * @ingroup Flipselector
21031     */
21032    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21033
21034    /**
21035     * Set the label of a given flip selector widget's item.
21036     *
21037     * @param item The item to set label on
21038     * @param label The text label string, in UTF-8 encoding
21039     *
21040     * @see elm_flipselector_item_label_get()
21041     *
21042     * @ingroup Flipselector
21043     */
21044    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
21045
21046    /**
21047     * Gets the item before @p item in a flip selector widget's
21048     * internal list of items.
21049     *
21050     * @param item The item to fetch previous from
21051     * @return The item before the @p item, in its parent's list. If
21052     *         there is no previous item for @p item or there's an
21053     *         error, @c NULL is returned.
21054     *
21055     * @see elm_flipselector_item_next_get()
21056     *
21057     * @ingroup Flipselector
21058     */
21059    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21060
21061    /**
21062     * Gets the item after @p item in a flip selector widget's
21063     * internal list of items.
21064     *
21065     * @param item The item to fetch next from
21066     * @return The item after the @p item, in its parent's list. If
21067     *         there is no next item for @p item or there's an
21068     *         error, @c NULL is returned.
21069     *
21070     * @see elm_flipselector_item_next_get()
21071     *
21072     * @ingroup Flipselector
21073     */
21074    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21075
21076    /**
21077     * Set the interval on time updates for an user mouse button hold
21078     * on a flip selector widget.
21079     *
21080     * @param obj The flip selector object
21081     * @param interval The (first) interval value in seconds
21082     *
21083     * This interval value is @b decreased while the user holds the
21084     * mouse pointer either flipping up or flipping doww a given flip
21085     * selector.
21086     *
21087     * This helps the user to get to a given item distant from the
21088     * current one easier/faster, as it will start to flip quicker and
21089     * quicker on mouse button holds.
21090     *
21091     * The calculation for the next flip interval value, starting from
21092     * the one set with this call, is the previous interval divided by
21093     * 1.05, so it decreases a little bit.
21094     *
21095     * The default starting interval value for automatic flips is
21096     * @b 0.85 seconds.
21097     *
21098     * @see elm_flipselector_interval_get()
21099     *
21100     * @ingroup Flipselector
21101     */
21102    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21103
21104    /**
21105     * Get the interval on time updates for an user mouse button hold
21106     * on a flip selector widget.
21107     *
21108     * @param obj The flip selector object
21109     * @return The (first) interval value, in seconds, set on it
21110     *
21111     * @see elm_flipselector_interval_set() for more details
21112     *
21113     * @ingroup Flipselector
21114     */
21115    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21116
21117    /**
21118     * @}
21119     */
21120
21121    /**
21122     * @addtogroup Animator Animator
21123     * @ingroup Elementary
21124     *
21125     * @brief Functions to ease creation of animations.
21126     *
21127     * elm_animator is designed to provide an easy way to create animations.
21128     * Creating an animation with elm_animator is as simple as setting a
21129     * duration, an operating callback and telling it to run the animation.
21130     * However that is not the full extent of elm_animator's ability, animations
21131     * can be paused and resumed, reversed and the animation need not be linear.
21132     *
21133     * To run an animation you must specify at least a duration and operation
21134     * callback, not setting any other properties will create a linear animation
21135     * that runs once and is not reversed.
21136     *
21137     * @ref elm_animator_example_page_01 "This" example should make all of that
21138     * very clear.
21139     *
21140     * @warning elm_animator is @b not a widget.
21141     * @{
21142     */
21143    /**
21144     * @brief Type of curve desired for animation.
21145     *
21146     * The speed in which an animation happens doesn't have to be linear, some
21147     * animations will look better if they're accelerating or decelerating, so
21148     * elm_animator provides four options in this regard:
21149     *
21150     * @image html elm_animator_curve_style.png
21151     * @image latex elm_animator_curve_style.eps width=\textwidth
21152     * As can be seen in the image the speed of the animation will be:
21153     * @li ELM_ANIMATOR_CURVE_LINEAR constant
21154     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
21155     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
21156     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
21157     */
21158    typedef enum
21159      {
21160         ELM_ANIMATOR_CURVE_LINEAR,
21161         ELM_ANIMATOR_CURVE_IN_OUT,
21162         ELM_ANIMATOR_CURVE_IN,
21163         ELM_ANIMATOR_CURVE_OUT
21164      } Elm_Animator_Curve_Style;
21165    typedef struct _Elm_Animator Elm_Animator;
21166   /**
21167    * Called back per loop of an elementary animators cycle
21168    * @param data user-data given to elm_animator_operation_callback_set()
21169    * @param animator the animator being run
21170    * @param double the position in the animation
21171    */
21172    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
21173   /**
21174    * Called back when an elementary animator finishes
21175    * @param data user-data given to elm_animator_completion_callback_set()
21176    */
21177    typedef void (*Elm_Animator_Completion_Cb) (void *data);
21178
21179    /**
21180     * @brief Create a new animator.
21181     *
21182     * @param[in] parent Parent object
21183     *
21184     * The @a parent argument can be set to NULL for no parent. If a parent is set
21185     * there is no need to call elm_animator_del(), when the parent is deleted it
21186     * will delete the animator.
21187     * @deprecated Use @ref Transit instead.
21188     */
21189    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
21190    /**
21191     * Deletes the animator freeing any resources it used. If the animator was
21192     * created with a NULL parent this must be called, otherwise it will be
21193     * automatically called when the parent is deleted.
21194     *
21195     * @param[in] animator Animator object
21196     * @deprecated Use @ref Transit instead.
21197     */
21198    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21199    /**
21200     * Set the duration of the animation.
21201     *
21202     * @param[in] animator Animator object
21203     * @param[in] duration Duration in second
21204     * @deprecated Use @ref Transit instead.
21205     */
21206    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
21207    /**
21208     * @brief Set the callback function for animator operation.
21209     *
21210     * @param[in] animator Animator object
21211     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
21212     * @param[in] data Callback function user argument
21213     *
21214     * The @p func callback will be called with a frame value in range [0, 1] which
21215     * indicates how far along the animation should be. It is the job of @p func to
21216     * actually change the state of any object(or objects) that are being animated.
21217     * @deprecated Use @ref Transit instead.
21218     */
21219    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
21220    /**
21221     * Set the callback function for the when the animation ends.
21222     *
21223     * @param[in]  animator Animator object
21224     * @param[in]  func   Callback function pointe
21225     * @param[in]  data Callback function user argument
21226     *
21227     * @warning @a func will not be executed if elm_animator_stop() is called.
21228     * @deprecated Use @ref Transit instead.
21229     */
21230    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
21231    /**
21232     * @brief Stop animator.
21233     *
21234     * @param[in] animator Animator object
21235     *
21236     * If called before elm_animator_animate() it does nothing. If there is an
21237     * animation in progress the animation will be stopped(the operation callback
21238     * will not be executed again) and it can't be restarted using
21239     * elm_animator_resume().
21240     * @deprecated Use @ref Transit instead.
21241     */
21242    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21243    /**
21244     * Set the animator repeat count.
21245     *
21246     * @param[in]  animator Animator object
21247     * @param[in]  repeat_cnt Repeat count
21248     * @deprecated Use @ref Transit instead.
21249     */
21250    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
21251    /**
21252     * @brief Start animation.
21253     *
21254     * @param[in] animator Animator object
21255     *
21256     * This function starts the animation if the nescessary properties(duration
21257     * and operation callback) have been set. Once started the animation will
21258     * run until complete or elm_animator_stop() is called.
21259     * @deprecated Use @ref Transit instead.
21260     */
21261    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21262    /**
21263     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21264     *
21265     * @param[in] animator Animator object
21266     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21267     * @deprecated Use @ref Transit instead.
21268     */
21269    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
21270    /**
21271     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
21272     *
21273     * @param[in] animator Animator object
21274     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
21275     * @deprecated Use @ref Transit instead.
21276     */
21277    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21278    /**
21279     * @brief Sets wether the animation should be automatically reversed.
21280     *
21281     * @param[in] animator Animator object
21282     * @param[in] reverse Reverse or not
21283     *
21284     * This controls wether the animation will be run on reverse imediately after
21285     * running forward. When this is set together with repetition the animation
21286     * will run in reverse once for each time it ran forward.@n
21287     * Runnin an animation in reverse is accomplished by calling the operation
21288     * callback with a frame value starting at 1 and diminshing until 0.
21289     * @deprecated Use @ref Transit instead.
21290     */
21291    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
21292    /**
21293     * Gets wether the animation will automatically reversed
21294     *
21295     * @param[in] animator Animator object
21296     * @deprecated Use @ref Transit instead.
21297     */
21298    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21299    /**
21300     * Gets the status for the animator operation. The status of the animator @b
21301     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
21302     * only informs if the animation was started and has not ended(either normally
21303     * or through elm_animator_stop()).
21304     *
21305     * @param[in] animator Animator object
21306     * @deprecated Use @ref Transit instead.
21307     */
21308    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21309    /**
21310     * Gets how many times the animation will be repeated
21311     *
21312     * @param[in] animator Animator object
21313     * @deprecated Use @ref Transit instead.
21314     */
21315    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
21316    /**
21317     * Pause the animator.
21318     *
21319     * @param[in]  animator Animator object
21320     *
21321     * This causes the animation to be temporarily stopped(the operation callback
21322     * will not be called). If the animation is not yet running this is a no-op.
21323     * Once an animation has been paused with this function it can be resumed
21324     * using elm_animator_resume().
21325     * @deprecated Use @ref Transit instead.
21326     */
21327    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21328    /**
21329     * @brief Resumes the animator.
21330     *
21331     * @param[in]  animator Animator object
21332     *
21333     * Resumes an animation that was paused using elm_animator_pause(), after
21334     * calling this function calls to the operation callback will happen
21335     * normally. If an animation is stopped by means of elm_animator_stop it
21336     * @b can't be restarted with this function.@n
21337     *
21338     * @warning When an animation is resumed it doesn't start from where it was paused, it
21339     * will go to where it would have been if it had not been paused. If an
21340     * animation with a duration of 3 seconds is paused after 1 second for 1 second
21341     * it will resume as if it had ben animating for 2 seconds, the operating
21342     * callback will be called with a frame value of aproximately 2/3.
21343     * @deprecated Use @ref Transit instead.
21344     */
21345    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
21346    /**
21347     * @}
21348     */
21349
21350    /**
21351     * @defgroup Calendar Calendar
21352     * @ingroup Elementary
21353     *
21354     * @image html img/widget/calendar/preview-00.png
21355     * @image latex img/widget/calendar/preview-00.eps
21356     *
21357     * A calendar is a widget that displays a regular calendar, one
21358     * month at a time, to the user, and can allows the user to select a date.
21359     *
21360     * It has support to adding check marks (holidays and checks are supported
21361     * by default theme).
21362     *
21363     * Weekday names and the function used to format month and year to
21364     * be displayed can be set, giving more flexibility to this widget.
21365     *
21366     * Smart callbacks one can register to:
21367     * - "changed" - emitted when the user selects a day or changes the
21368     *   displayed month, what actually changes the selected day as well.
21369     *
21370     * Available styles for it:
21371     * - @c "default"
21372     *
21373     * List of examples:
21374     * @li @ref calendar_example_01
21375     * @li @ref calendar_example_02
21376     * @li @ref calendar_example_03
21377     * @li @ref calendar_example_04
21378     * @li @ref calendar_example_05
21379     * @li @ref calendar_example_06
21380     */
21381
21382    /**
21383     * @addtogroup Calendar
21384     * @{
21385     */
21386
21387    /**
21388     * @enum _Elm_Calendar_Mark_Repeat
21389     * @typedef Elm_Calendar_Mark_Repeat
21390     *
21391     * Event periodicity, used to define if a mark should be repeated
21392     * @b beyond event's day. It's set when a mark is added.
21393     *
21394     * So, for a mark added to 13th May with periodicity set to WEEKLY,
21395     * there will be marks every week after this date. Marks will be displayed
21396     * at 13th, 20th, 27th, 3rd June ...
21397     *
21398     * Values don't work as bitmask, only one can be choosen.
21399     *
21400     * @see elm_calendar_mark_add()
21401     *
21402     * @ingroup Calendar
21403     */
21404    typedef enum _Elm_Calendar_Mark_Repeat
21405      {
21406         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21407         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21408         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21409         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*/
21410         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. */
21411      } Elm_Calendar_Mark_Repeat;
21412
21413    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(). */
21414
21415    /**
21416     * Add a new calendar widget to the given parent Elementary
21417     * (container) object.
21418     *
21419     * @param parent The parent object.
21420     * @return a new calendar widget handle or @c NULL, on errors.
21421     *
21422     * This function inserts a new calendar widget on the canvas.
21423     *
21424     * @ref calendar_example_01
21425     *
21426     * @ingroup Calendar
21427     */
21428    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21429
21430    /**
21431     * Get weekdays names displayed by the calendar.
21432     *
21433     * @param obj The calendar object.
21434     * @return Array of seven strings to be used as weekday names.
21435     *
21436     * By default, weekdays abbreviations get from system are displayed:
21437     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21438     * The first string is related to Sunday, the second to Monday...
21439     *
21440     * @see elm_calendar_weekdays_name_set()
21441     *
21442     * @ref calendar_example_05
21443     *
21444     * @ingroup Calendar
21445     */
21446    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21447
21448    /**
21449     * Set weekdays names to be displayed by the calendar.
21450     *
21451     * @param obj The calendar object.
21452     * @param weekdays Array of seven strings to be used as weekday names.
21453     * @warning It must have 7 elements, or it will access invalid memory.
21454     * @warning The strings must be NULL terminated ('@\0').
21455     *
21456     * By default, weekdays abbreviations get from system are displayed:
21457     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21458     *
21459     * The first string should be related to Sunday, the second to Monday...
21460     *
21461     * The usage should be like this:
21462     * @code
21463     *   const char *weekdays[] =
21464     *   {
21465     *      "Sunday", "Monday", "Tuesday", "Wednesday",
21466     *      "Thursday", "Friday", "Saturday"
21467     *   };
21468     *   elm_calendar_weekdays_names_set(calendar, weekdays);
21469     * @endcode
21470     *
21471     * @see elm_calendar_weekdays_name_get()
21472     *
21473     * @ref calendar_example_02
21474     *
21475     * @ingroup Calendar
21476     */
21477    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21478
21479    /**
21480     * Set the minimum and maximum values for the year
21481     *
21482     * @param obj The calendar object
21483     * @param min The minimum year, greater than 1901;
21484     * @param max The maximum year;
21485     *
21486     * Maximum must be greater than minimum, except if you don't wan't to set
21487     * maximum year.
21488     * Default values are 1902 and -1.
21489     *
21490     * If the maximum year is a negative value, it will be limited depending
21491     * on the platform architecture (year 2037 for 32 bits);
21492     *
21493     * @see elm_calendar_min_max_year_get()
21494     *
21495     * @ref calendar_example_03
21496     *
21497     * @ingroup Calendar
21498     */
21499    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21500
21501    /**
21502     * Get the minimum and maximum values for the year
21503     *
21504     * @param obj The calendar object.
21505     * @param min The minimum year.
21506     * @param max The maximum year.
21507     *
21508     * Default values are 1902 and -1.
21509     *
21510     * @see elm_calendar_min_max_year_get() for more details.
21511     *
21512     * @ref calendar_example_05
21513     *
21514     * @ingroup Calendar
21515     */
21516    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21517
21518    /**
21519     * Enable or disable day selection
21520     *
21521     * @param obj The calendar object.
21522     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21523     * disable it.
21524     *
21525     * Enabled by default. If disabled, the user still can select months,
21526     * but not days. Selected days are highlighted on calendar.
21527     * It should be used if you won't need such selection for the widget usage.
21528     *
21529     * When a day is selected, or month is changed, smart callbacks for
21530     * signal "changed" will be called.
21531     *
21532     * @see elm_calendar_day_selection_enable_get()
21533     *
21534     * @ref calendar_example_04
21535     *
21536     * @ingroup Calendar
21537     */
21538    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21539
21540    /**
21541     * Get a value whether day selection is enabled or not.
21542     *
21543     * @see elm_calendar_day_selection_enable_set() for details.
21544     *
21545     * @param obj The calendar object.
21546     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21547     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21548     *
21549     * @ref calendar_example_05
21550     *
21551     * @ingroup Calendar
21552     */
21553    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21554
21555
21556    /**
21557     * Set selected date to be highlighted on calendar.
21558     *
21559     * @param obj The calendar object.
21560     * @param selected_time A @b tm struct to represent the selected date.
21561     *
21562     * Set the selected date, changing the displayed month if needed.
21563     * Selected date changes when the user goes to next/previous month or
21564     * select a day pressing over it on calendar.
21565     *
21566     * @see elm_calendar_selected_time_get()
21567     *
21568     * @ref calendar_example_04
21569     *
21570     * @ingroup Calendar
21571     */
21572    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21573
21574    /**
21575     * Get selected date.
21576     *
21577     * @param obj The calendar object
21578     * @param selected_time A @b tm struct to point to selected date
21579     * @return EINA_FALSE means an error ocurred and returned time shouldn't
21580     * be considered.
21581     *
21582     * Get date selected by the user or set by function
21583     * elm_calendar_selected_time_set().
21584     * Selected date changes when the user goes to next/previous month or
21585     * select a day pressing over it on calendar.
21586     *
21587     * @see elm_calendar_selected_time_get()
21588     *
21589     * @ref calendar_example_05
21590     *
21591     * @ingroup Calendar
21592     */
21593    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21594
21595    /**
21596     * Set a function to format the string that will be used to display
21597     * month and year;
21598     *
21599     * @param obj The calendar object
21600     * @param format_function Function to set the month-year string given
21601     * the selected date
21602     *
21603     * By default it uses strftime with "%B %Y" format string.
21604     * It should allocate the memory that will be used by the string,
21605     * that will be freed by the widget after usage.
21606     * A pointer to the string and a pointer to the time struct will be provided.
21607     *
21608     * Example:
21609     * @code
21610     * static char *
21611     * _format_month_year(struct tm *selected_time)
21612     * {
21613     *    char buf[32];
21614     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21615     *    return strdup(buf);
21616     * }
21617     *
21618     * elm_calendar_format_function_set(calendar, _format_month_year);
21619     * @endcode
21620     *
21621     * @ref calendar_example_02
21622     *
21623     * @ingroup Calendar
21624     */
21625    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21626
21627    /**
21628     * Add a new mark to the calendar
21629     *
21630     * @param obj The calendar object
21631     * @param mark_type A string used to define the type of mark. It will be
21632     * emitted to the theme, that should display a related modification on these
21633     * days representation.
21634     * @param mark_time A time struct to represent the date of inclusion of the
21635     * mark. For marks that repeats it will just be displayed after the inclusion
21636     * date in the calendar.
21637     * @param repeat Repeat the event following this periodicity. Can be a unique
21638     * mark (that don't repeat), daily, weekly, monthly or annually.
21639     * @return The created mark or @p NULL upon failure.
21640     *
21641     * Add a mark that will be drawn in the calendar respecting the insertion
21642     * time and periodicity. It will emit the type as signal to the widget theme.
21643     * Default theme supports "holiday" and "checked", but it can be extended.
21644     *
21645     * It won't immediately update the calendar, drawing the marks.
21646     * For this, call elm_calendar_marks_draw(). However, when user selects
21647     * next or previous month calendar forces marks drawn.
21648     *
21649     * Marks created with this method can be deleted with
21650     * elm_calendar_mark_del().
21651     *
21652     * Example
21653     * @code
21654     * struct tm selected_time;
21655     * time_t current_time;
21656     *
21657     * current_time = time(NULL) + 5 * 84600;
21658     * localtime_r(&current_time, &selected_time);
21659     * elm_calendar_mark_add(cal, "holiday", selected_time,
21660     *     ELM_CALENDAR_ANNUALLY);
21661     *
21662     * current_time = time(NULL) + 1 * 84600;
21663     * localtime_r(&current_time, &selected_time);
21664     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21665     *
21666     * elm_calendar_marks_draw(cal);
21667     * @endcode
21668     *
21669     * @see elm_calendar_marks_draw()
21670     * @see elm_calendar_mark_del()
21671     *
21672     * @ref calendar_example_06
21673     *
21674     * @ingroup Calendar
21675     */
21676    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);
21677
21678    /**
21679     * Delete mark from the calendar.
21680     *
21681     * @param mark The mark to be deleted.
21682     *
21683     * If deleting all calendar marks is required, elm_calendar_marks_clear()
21684     * should be used instead of getting marks list and deleting each one.
21685     *
21686     * @see elm_calendar_mark_add()
21687     *
21688     * @ref calendar_example_06
21689     *
21690     * @ingroup Calendar
21691     */
21692    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21693
21694    /**
21695     * Remove all calendar's marks
21696     *
21697     * @param obj The calendar object.
21698     *
21699     * @see elm_calendar_mark_add()
21700     * @see elm_calendar_mark_del()
21701     *
21702     * @ingroup Calendar
21703     */
21704    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21705
21706
21707    /**
21708     * Get a list of all the calendar marks.
21709     *
21710     * @param obj The calendar object.
21711     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21712     *
21713     * @see elm_calendar_mark_add()
21714     * @see elm_calendar_mark_del()
21715     * @see elm_calendar_marks_clear()
21716     *
21717     * @ingroup Calendar
21718     */
21719    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21720
21721    /**
21722     * Draw calendar marks.
21723     *
21724     * @param obj The calendar object.
21725     *
21726     * Should be used after adding, removing or clearing marks.
21727     * It will go through the entire marks list updating the calendar.
21728     * If lots of marks will be added, add all the marks and then call
21729     * this function.
21730     *
21731     * When the month is changed, i.e. user selects next or previous month,
21732     * marks will be drawed.
21733     *
21734     * @see elm_calendar_mark_add()
21735     * @see elm_calendar_mark_del()
21736     * @see elm_calendar_marks_clear()
21737     *
21738     * @ref calendar_example_06
21739     *
21740     * @ingroup Calendar
21741     */
21742    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21743
21744    /**
21745     * Set a day text color to the same that represents Saturdays.
21746     *
21747     * @param obj The calendar object.
21748     * @param pos The text position. Position is the cell counter, from left
21749     * to right, up to down. It starts on 0 and ends on 41.
21750     *
21751     * @deprecated use elm_calendar_mark_add() instead like:
21752     *
21753     * @code
21754     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21755     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21756     * @endcode
21757     *
21758     * @see elm_calendar_mark_add()
21759     *
21760     * @ingroup Calendar
21761     */
21762    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21763
21764    /**
21765     * Set a day text color to the same that represents Sundays.
21766     *
21767     * @param obj The calendar object.
21768     * @param pos The text position. Position is the cell counter, from left
21769     * to right, up to down. It starts on 0 and ends on 41.
21770
21771     * @deprecated use elm_calendar_mark_add() instead like:
21772     *
21773     * @code
21774     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21775     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21776     * @endcode
21777     *
21778     * @see elm_calendar_mark_add()
21779     *
21780     * @ingroup Calendar
21781     */
21782    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21783
21784    /**
21785     * Set a day text color to the same that represents Weekdays.
21786     *
21787     * @param obj The calendar object
21788     * @param pos The text position. Position is the cell counter, from left
21789     * to right, up to down. It starts on 0 and ends on 41.
21790     *
21791     * @deprecated use elm_calendar_mark_add() instead like:
21792     *
21793     * @code
21794     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21795     *
21796     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21797     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21798     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21799     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21800     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21801     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21802     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21803     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21804     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21805     * @endcode
21806     *
21807     * @see elm_calendar_mark_add()
21808     *
21809     * @ingroup Calendar
21810     */
21811    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21812
21813    /**
21814     * Set the interval on time updates for an user mouse button hold
21815     * on calendar widgets' month selection.
21816     *
21817     * @param obj The calendar object
21818     * @param interval The (first) interval value in seconds
21819     *
21820     * This interval value is @b decreased while the user holds the
21821     * mouse pointer either selecting next or previous month.
21822     *
21823     * This helps the user to get to a given month distant from the
21824     * current one easier/faster, as it will start to change quicker and
21825     * quicker on mouse button holds.
21826     *
21827     * The calculation for the next change interval value, starting from
21828     * the one set with this call, is the previous interval divided by
21829     * 1.05, so it decreases a little bit.
21830     *
21831     * The default starting interval value for automatic changes is
21832     * @b 0.85 seconds.
21833     *
21834     * @see elm_calendar_interval_get()
21835     *
21836     * @ingroup Calendar
21837     */
21838    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21839
21840    /**
21841     * Get the interval on time updates for an user mouse button hold
21842     * on calendar widgets' month selection.
21843     *
21844     * @param obj The calendar object
21845     * @return The (first) interval value, in seconds, set on it
21846     *
21847     * @see elm_calendar_interval_set() for more details
21848     *
21849     * @ingroup Calendar
21850     */
21851    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21852
21853    /**
21854     * @}
21855     */
21856
21857    /**
21858     * @defgroup Diskselector Diskselector
21859     * @ingroup Elementary
21860     *
21861     * @image html img/widget/diskselector/preview-00.png
21862     * @image latex img/widget/diskselector/preview-00.eps
21863     *
21864     * A diskselector is a kind of list widget. It scrolls horizontally,
21865     * and can contain label and icon objects. Three items are displayed
21866     * with the selected one in the middle.
21867     *
21868     * It can act like a circular list with round mode and labels can be
21869     * reduced for a defined length for side items.
21870     *
21871     * Smart callbacks one can listen to:
21872     * - "selected" - when item is selected, i.e. scroller stops.
21873     *
21874     * Available styles for it:
21875     * - @c "default"
21876     *
21877     * List of examples:
21878     * @li @ref diskselector_example_01
21879     * @li @ref diskselector_example_02
21880     */
21881
21882    /**
21883     * @addtogroup Diskselector
21884     * @{
21885     */
21886
21887    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(). */
21888
21889    /**
21890     * Add a new diskselector widget to the given parent Elementary
21891     * (container) object.
21892     *
21893     * @param parent The parent object.
21894     * @return a new diskselector widget handle or @c NULL, on errors.
21895     *
21896     * This function inserts a new diskselector widget on the canvas.
21897     *
21898     * @ingroup Diskselector
21899     */
21900    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21901
21902    /**
21903     * Enable or disable round mode.
21904     *
21905     * @param obj The diskselector object.
21906     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21907     * disable it.
21908     *
21909     * Disabled by default. If round mode is enabled the items list will
21910     * work like a circle list, so when the user reaches the last item,
21911     * the first one will popup.
21912     *
21913     * @see elm_diskselector_round_get()
21914     *
21915     * @ingroup Diskselector
21916     */
21917    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21918
21919    /**
21920     * Get a value whether round mode is enabled or not.
21921     *
21922     * @see elm_diskselector_round_set() for details.
21923     *
21924     * @param obj The diskselector object.
21925     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21926     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21927     *
21928     * @ingroup Diskselector
21929     */
21930    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21931
21932    /**
21933     * Get the side labels max length.
21934     *
21935     * @deprecated use elm_diskselector_side_label_length_get() instead:
21936     *
21937     * @param obj The diskselector object.
21938     * @return The max length defined for side labels, or 0 if not a valid
21939     * diskselector.
21940     *
21941     * @ingroup Diskselector
21942     */
21943    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21944
21945    /**
21946     * Set the side labels max length.
21947     *
21948     * @deprecated use elm_diskselector_side_label_length_set() instead:
21949     *
21950     * @param obj The diskselector object.
21951     * @param len The max length defined for side labels.
21952     *
21953     * @ingroup Diskselector
21954     */
21955    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21956
21957    /**
21958     * Get the side labels max length.
21959     *
21960     * @see elm_diskselector_side_label_length_set() for details.
21961     *
21962     * @param obj The diskselector object.
21963     * @return The max length defined for side labels, or 0 if not a valid
21964     * diskselector.
21965     *
21966     * @ingroup Diskselector
21967     */
21968    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21969
21970    /**
21971     * Set the side labels max length.
21972     *
21973     * @param obj The diskselector object.
21974     * @param len The max length defined for side labels.
21975     *
21976     * Length is the number of characters of items' label that will be
21977     * visible when it's set on side positions. It will just crop
21978     * the string after defined size. E.g.:
21979     *
21980     * An item with label "January" would be displayed on side position as
21981     * "Jan" if max length is set to 3, or "Janu", if this property
21982     * is set to 4.
21983     *
21984     * When it's selected, the entire label will be displayed, except for
21985     * width restrictions. In this case label will be cropped and "..."
21986     * will be concatenated.
21987     *
21988     * Default side label max length is 3.
21989     *
21990     * This property will be applyed over all items, included before or
21991     * later this function call.
21992     *
21993     * @ingroup Diskselector
21994     */
21995    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21996
21997    /**
21998     * Set the number of items to be displayed.
21999     *
22000     * @param obj The diskselector object.
22001     * @param num The number of items the diskselector will display.
22002     *
22003     * Default value is 3, and also it's the minimun. If @p num is less
22004     * than 3, it will be set to 3.
22005     *
22006     * Also, it can be set on theme, using data item @c display_item_num
22007     * on group "elm/diskselector/item/X", where X is style set.
22008     * E.g.:
22009     *
22010     * group { name: "elm/diskselector/item/X";
22011     * data {
22012     *     item: "display_item_num" "5";
22013     *     }
22014     *
22015     * @ingroup Diskselector
22016     */
22017    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
22018
22019    /**
22020     * Set bouncing behaviour when the scrolled content reaches an edge.
22021     *
22022     * Tell the internal scroller object whether it should bounce or not
22023     * when it reaches the respective edges for each axis.
22024     *
22025     * @param obj The diskselector object.
22026     * @param h_bounce Whether to bounce or not in the horizontal axis.
22027     * @param v_bounce Whether to bounce or not in the vertical axis.
22028     *
22029     * @see elm_scroller_bounce_set()
22030     *
22031     * @ingroup Diskselector
22032     */
22033    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22034
22035    /**
22036     * Get the bouncing behaviour of the internal scroller.
22037     *
22038     * Get whether the internal scroller should bounce when the edge of each
22039     * axis is reached scrolling.
22040     *
22041     * @param obj The diskselector object.
22042     * @param h_bounce Pointer where to store the bounce state of the horizontal
22043     * axis.
22044     * @param v_bounce Pointer where to store the bounce state of the vertical
22045     * axis.
22046     *
22047     * @see elm_scroller_bounce_get()
22048     * @see elm_diskselector_bounce_set()
22049     *
22050     * @ingroup Diskselector
22051     */
22052    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22053
22054    /**
22055     * Get the scrollbar policy.
22056     *
22057     * @see elm_diskselector_scroller_policy_get() for details.
22058     *
22059     * @param obj The diskselector object.
22060     * @param policy_h Pointer where to store horizontal scrollbar policy.
22061     * @param policy_v Pointer where to store vertical scrollbar policy.
22062     *
22063     * @ingroup Diskselector
22064     */
22065    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);
22066
22067    /**
22068     * Set the scrollbar policy.
22069     *
22070     * @param obj The diskselector object.
22071     * @param policy_h Horizontal scrollbar policy.
22072     * @param policy_v Vertical scrollbar policy.
22073     *
22074     * This sets the scrollbar visibility policy for the given scroller.
22075     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
22076     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
22077     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
22078     * This applies respectively for the horizontal and vertical scrollbars.
22079     *
22080     * The both are disabled by default, i.e., are set to
22081     * #ELM_SCROLLER_POLICY_OFF.
22082     *
22083     * @ingroup Diskselector
22084     */
22085    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
22086
22087    /**
22088     * Remove all diskselector's items.
22089     *
22090     * @param obj The diskselector object.
22091     *
22092     * @see elm_diskselector_item_del()
22093     * @see elm_diskselector_item_append()
22094     *
22095     * @ingroup Diskselector
22096     */
22097    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22098
22099    /**
22100     * Get a list of all the diskselector items.
22101     *
22102     * @param obj The diskselector object.
22103     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22104     * or @c NULL on failure.
22105     *
22106     * @see elm_diskselector_item_append()
22107     * @see elm_diskselector_item_del()
22108     * @see elm_diskselector_clear()
22109     *
22110     * @ingroup Diskselector
22111     */
22112    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22113
22114    /**
22115     * Appends a new item to the diskselector object.
22116     *
22117     * @param obj The diskselector object.
22118     * @param label The label of the diskselector item.
22119     * @param icon The icon object to use at left side of the item. An
22120     * icon can be any Evas object, but usually it is an icon created
22121     * with elm_icon_add().
22122     * @param func The function to call when the item is selected.
22123     * @param data The data to associate with the item for related callbacks.
22124     *
22125     * @return The created item or @c NULL upon failure.
22126     *
22127     * A new item will be created and appended to the diskselector, i.e., will
22128     * be set as last item. Also, if there is no selected item, it will
22129     * be selected. This will always happens for the first appended item.
22130     *
22131     * If no icon is set, label will be centered on item position, otherwise
22132     * the icon will be placed at left of the label, that will be shifted
22133     * to the right.
22134     *
22135     * Items created with this method can be deleted with
22136     * elm_diskselector_item_del().
22137     *
22138     * Associated @p data can be properly freed when item is deleted if a
22139     * callback function is set with elm_diskselector_item_del_cb_set().
22140     *
22141     * If a function is passed as argument, it will be called everytime this item
22142     * is selected, i.e., the user stops the diskselector with this
22143     * item on center position. If such function isn't needed, just passing
22144     * @c NULL as @p func is enough. The same should be done for @p data.
22145     *
22146     * Simple example (with no function callback or data associated):
22147     * @code
22148     * disk = elm_diskselector_add(win);
22149     * ic = elm_icon_add(win);
22150     * elm_icon_file_set(ic, "path/to/image", NULL);
22151     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22152     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22153     * @endcode
22154     *
22155     * @see elm_diskselector_item_del()
22156     * @see elm_diskselector_item_del_cb_set()
22157     * @see elm_diskselector_clear()
22158     * @see elm_icon_add()
22159     *
22160     * @ingroup Diskselector
22161     */
22162    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);
22163
22164
22165    /**
22166     * Delete them item from the diskselector.
22167     *
22168     * @param it The item of diskselector to be deleted.
22169     *
22170     * If deleting all diskselector items is required, elm_diskselector_clear()
22171     * should be used instead of getting items list and deleting each one.
22172     *
22173     * @see elm_diskselector_clear()
22174     * @see elm_diskselector_item_append()
22175     * @see elm_diskselector_item_del_cb_set()
22176     *
22177     * @ingroup Diskselector
22178     */
22179    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22180
22181    /**
22182     * Set the function called when a diskselector item is freed.
22183     *
22184     * @param it The item to set the callback on
22185     * @param func The function called
22186     *
22187     * If there is a @p func, then it will be called prior item's memory release.
22188     * That will be called with the following arguments:
22189     * @li item's data;
22190     * @li item's Evas object;
22191     * @li item itself;
22192     *
22193     * This way, a data associated to a diskselector item could be properly
22194     * freed.
22195     *
22196     * @ingroup Diskselector
22197     */
22198    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22199
22200    /**
22201     * Get the data associated to the item.
22202     *
22203     * @param it The diskselector item
22204     * @return The data associated to @p it
22205     *
22206     * The return value is a pointer to data associated to @p item when it was
22207     * created, with function elm_diskselector_item_append(). If no data
22208     * was passed as argument, it will return @c NULL.
22209     *
22210     * @see elm_diskselector_item_append()
22211     *
22212     * @ingroup Diskselector
22213     */
22214    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22215
22216    /**
22217     * Set the icon associated to the item.
22218     *
22219     * @param it The diskselector item
22220     * @param icon The icon object to associate with @p it
22221     *
22222     * The icon object to use at left side of the item. An
22223     * icon can be any Evas object, but usually it is an icon created
22224     * with elm_icon_add().
22225     *
22226     * Once the icon object is set, a previously set one will be deleted.
22227     * @warning Setting the same icon for two items will cause the icon to
22228     * dissapear from the first item.
22229     *
22230     * If an icon was passed as argument on item creation, with function
22231     * elm_diskselector_item_append(), it will be already
22232     * associated to the item.
22233     *
22234     * @see elm_diskselector_item_append()
22235     * @see elm_diskselector_item_icon_get()
22236     *
22237     * @ingroup Diskselector
22238     */
22239    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22240
22241    /**
22242     * Get the icon associated to the item.
22243     *
22244     * @param it The diskselector item
22245     * @return The icon associated to @p it
22246     *
22247     * The return value is a pointer to the icon associated to @p item when it was
22248     * created, with function elm_diskselector_item_append(), or later
22249     * with function elm_diskselector_item_icon_set. If no icon
22250     * was passed as argument, it will return @c NULL.
22251     *
22252     * @see elm_diskselector_item_append()
22253     * @see elm_diskselector_item_icon_set()
22254     *
22255     * @ingroup Diskselector
22256     */
22257    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22258
22259    /**
22260     * Set the label of item.
22261     *
22262     * @param it The item of diskselector.
22263     * @param label The label of item.
22264     *
22265     * The label to be displayed by the item.
22266     *
22267     * If no icon is set, label will be centered on item position, otherwise
22268     * the icon will be placed at left of the label, that will be shifted
22269     * to the right.
22270     *
22271     * An item with label "January" would be displayed on side position as
22272     * "Jan" if max length is set to 3 with function
22273     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22274     * is set to 4.
22275     *
22276     * When this @p item is selected, the entire label will be displayed,
22277     * except for width restrictions.
22278     * In this case label will be cropped and "..." will be concatenated,
22279     * but only for display purposes. It will keep the entire string, so
22280     * if diskselector is resized the remaining characters will be displayed.
22281     *
22282     * If a label was passed as argument on item creation, with function
22283     * elm_diskselector_item_append(), it will be already
22284     * displayed by the item.
22285     *
22286     * @see elm_diskselector_side_label_lenght_set()
22287     * @see elm_diskselector_item_label_get()
22288     * @see elm_diskselector_item_append()
22289     *
22290     * @ingroup Diskselector
22291     */
22292    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22293
22294    /**
22295     * Get the label of item.
22296     *
22297     * @param it The item of diskselector.
22298     * @return The label of item.
22299     *
22300     * The return value is a pointer to the label associated to @p item when it was
22301     * created, with function elm_diskselector_item_append(), or later
22302     * with function elm_diskselector_item_label_set. If no label
22303     * was passed as argument, it will return @c NULL.
22304     *
22305     * @see elm_diskselector_item_label_set() for more details.
22306     * @see elm_diskselector_item_append()
22307     *
22308     * @ingroup Diskselector
22309     */
22310    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22311
22312    /**
22313     * Get the selected item.
22314     *
22315     * @param obj The diskselector object.
22316     * @return The selected diskselector item.
22317     *
22318     * The selected item can be unselected with function
22319     * elm_diskselector_item_selected_set(), and the first item of
22320     * diskselector will be selected.
22321     *
22322     * The selected item always will be centered on diskselector, with
22323     * full label displayed, i.e., max lenght set to side labels won't
22324     * apply on the selected item. More details on
22325     * elm_diskselector_side_label_length_set().
22326     *
22327     * @ingroup Diskselector
22328     */
22329    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22330
22331    /**
22332     * Set the selected state of an item.
22333     *
22334     * @param it The diskselector item
22335     * @param selected The selected state
22336     *
22337     * This sets the selected state of the given item @p it.
22338     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22339     *
22340     * If a new item is selected the previosly selected will be unselected.
22341     * Previoulsy selected item can be get with function
22342     * elm_diskselector_selected_item_get().
22343     *
22344     * If the item @p it is unselected, the first item of diskselector will
22345     * be selected.
22346     *
22347     * Selected items will be visible on center position of diskselector.
22348     * So if it was on another position before selected, or was invisible,
22349     * diskselector will animate items until the selected item reaches center
22350     * position.
22351     *
22352     * @see elm_diskselector_item_selected_get()
22353     * @see elm_diskselector_selected_item_get()
22354     *
22355     * @ingroup Diskselector
22356     */
22357    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22358
22359    /*
22360     * Get whether the @p item is selected or not.
22361     *
22362     * @param it The diskselector item.
22363     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22364     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22365     *
22366     * @see elm_diskselector_selected_item_set() for details.
22367     * @see elm_diskselector_item_selected_get()
22368     *
22369     * @ingroup Diskselector
22370     */
22371    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22372
22373    /**
22374     * Get the first item of the diskselector.
22375     *
22376     * @param obj The diskselector object.
22377     * @return The first item, or @c NULL if none.
22378     *
22379     * The list of items follows append order. So it will return the first
22380     * item appended to the widget that wasn't deleted.
22381     *
22382     * @see elm_diskselector_item_append()
22383     * @see elm_diskselector_items_get()
22384     *
22385     * @ingroup Diskselector
22386     */
22387    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22388
22389    /**
22390     * Get the last item of the diskselector.
22391     *
22392     * @param obj The diskselector object.
22393     * @return The last item, or @c NULL if none.
22394     *
22395     * The list of items follows append order. So it will return last first
22396     * item appended to the widget that wasn't deleted.
22397     *
22398     * @see elm_diskselector_item_append()
22399     * @see elm_diskselector_items_get()
22400     *
22401     * @ingroup Diskselector
22402     */
22403    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22404
22405    /**
22406     * Get the item before @p item in diskselector.
22407     *
22408     * @param it The diskselector item.
22409     * @return The item before @p item, or @c NULL if none or on failure.
22410     *
22411     * The list of items follows append order. So it will return item appended
22412     * just before @p item and that wasn't deleted.
22413     *
22414     * If it is the first item, @c NULL will be returned.
22415     * First item can be get by elm_diskselector_first_item_get().
22416     *
22417     * @see elm_diskselector_item_append()
22418     * @see elm_diskselector_items_get()
22419     *
22420     * @ingroup Diskselector
22421     */
22422    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22423
22424    /**
22425     * Get the item after @p item in diskselector.
22426     *
22427     * @param it The diskselector item.
22428     * @return The item after @p item, or @c NULL if none or on failure.
22429     *
22430     * The list of items follows append order. So it will return item appended
22431     * just after @p item and that wasn't deleted.
22432     *
22433     * If it is the last item, @c NULL will be returned.
22434     * Last item can be get by elm_diskselector_last_item_get().
22435     *
22436     * @see elm_diskselector_item_append()
22437     * @see elm_diskselector_items_get()
22438     *
22439     * @ingroup Diskselector
22440     */
22441    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22442
22443    /**
22444     * Set the text to be shown in the diskselector item.
22445     *
22446     * @param item Target item
22447     * @param text The text to set in the content
22448     *
22449     * Setup the text as tooltip to object. The item can have only one tooltip,
22450     * so any previous tooltip data is removed.
22451     *
22452     * @see elm_object_tooltip_text_set() for more details.
22453     *
22454     * @ingroup Diskselector
22455     */
22456    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22457
22458    /**
22459     * Set the content to be shown in the tooltip item.
22460     *
22461     * Setup the tooltip to item. The item can have only one tooltip,
22462     * so any previous tooltip data is removed. @p func(with @p data) will
22463     * be called every time that need show the tooltip and it should
22464     * return a valid Evas_Object. This object is then managed fully by
22465     * tooltip system and is deleted when the tooltip is gone.
22466     *
22467     * @param item the diskselector item being attached a tooltip.
22468     * @param func the function used to create the tooltip contents.
22469     * @param data what to provide to @a func as callback data/context.
22470     * @param del_cb called when data is not needed anymore, either when
22471     *        another callback replaces @p func, the tooltip is unset with
22472     *        elm_diskselector_item_tooltip_unset() or the owner @a item
22473     *        dies. This callback receives as the first parameter the
22474     *        given @a data, and @c event_info is the item.
22475     *
22476     * @see elm_object_tooltip_content_cb_set() for more details.
22477     *
22478     * @ingroup Diskselector
22479     */
22480    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);
22481
22482    /**
22483     * Unset tooltip from item.
22484     *
22485     * @param item diskselector item to remove previously set tooltip.
22486     *
22487     * Remove tooltip from item. The callback provided as del_cb to
22488     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22489     * it is not used anymore.
22490     *
22491     * @see elm_object_tooltip_unset() for more details.
22492     * @see elm_diskselector_item_tooltip_content_cb_set()
22493     *
22494     * @ingroup Diskselector
22495     */
22496    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22497
22498
22499    /**
22500     * Sets a different style for this item tooltip.
22501     *
22502     * @note before you set a style you should define a tooltip with
22503     *       elm_diskselector_item_tooltip_content_cb_set() or
22504     *       elm_diskselector_item_tooltip_text_set()
22505     *
22506     * @param item diskselector item with tooltip already set.
22507     * @param style the theme style to use (default, transparent, ...)
22508     *
22509     * @see elm_object_tooltip_style_set() for more details.
22510     *
22511     * @ingroup Diskselector
22512     */
22513    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22514
22515    /**
22516     * Get the style for this item tooltip.
22517     *
22518     * @param item diskselector item with tooltip already set.
22519     * @return style the theme style in use, defaults to "default". If the
22520     *         object does not have a tooltip set, then NULL is returned.
22521     *
22522     * @see elm_object_tooltip_style_get() for more details.
22523     * @see elm_diskselector_item_tooltip_style_set()
22524     *
22525     * @ingroup Diskselector
22526     */
22527    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22528
22529    /**
22530     * Set the cursor to be shown when mouse is over the diskselector item
22531     *
22532     * @param item Target item
22533     * @param cursor the cursor name to be used.
22534     *
22535     * @see elm_object_cursor_set() for more details.
22536     *
22537     * @ingroup Diskselector
22538     */
22539    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22540
22541    /**
22542     * Get the cursor to be shown when mouse is over the diskselector item
22543     *
22544     * @param item diskselector item with cursor already set.
22545     * @return the cursor name.
22546     *
22547     * @see elm_object_cursor_get() for more details.
22548     * @see elm_diskselector_cursor_set()
22549     *
22550     * @ingroup Diskselector
22551     */
22552    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22553
22554
22555    /**
22556     * Unset the cursor to be shown when mouse is over the diskselector item
22557     *
22558     * @param item Target item
22559     *
22560     * @see elm_object_cursor_unset() for more details.
22561     * @see elm_diskselector_cursor_set()
22562     *
22563     * @ingroup Diskselector
22564     */
22565    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22566
22567    /**
22568     * Sets a different style for this item cursor.
22569     *
22570     * @note before you set a style you should define a cursor with
22571     *       elm_diskselector_item_cursor_set()
22572     *
22573     * @param item diskselector item with cursor already set.
22574     * @param style the theme style to use (default, transparent, ...)
22575     *
22576     * @see elm_object_cursor_style_set() for more details.
22577     *
22578     * @ingroup Diskselector
22579     */
22580    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22581
22582
22583    /**
22584     * Get the style for this item cursor.
22585     *
22586     * @param item diskselector item with cursor already set.
22587     * @return style the theme style in use, defaults to "default". If the
22588     *         object does not have a cursor set, then @c NULL is returned.
22589     *
22590     * @see elm_object_cursor_style_get() for more details.
22591     * @see elm_diskselector_item_cursor_style_set()
22592     *
22593     * @ingroup Diskselector
22594     */
22595    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22596
22597
22598    /**
22599     * Set if the cursor set should be searched on the theme or should use
22600     * the provided by the engine, only.
22601     *
22602     * @note before you set if should look on theme you should define a cursor
22603     * with elm_diskselector_item_cursor_set().
22604     * By default it will only look for cursors provided by the engine.
22605     *
22606     * @param item widget item with cursor already set.
22607     * @param engine_only boolean to define if cursors set with
22608     * elm_diskselector_item_cursor_set() should be searched only
22609     * between cursors provided by the engine or searched on widget's
22610     * theme as well.
22611     *
22612     * @see elm_object_cursor_engine_only_set() for more details.
22613     *
22614     * @ingroup Diskselector
22615     */
22616    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22617
22618    /**
22619     * Get the cursor engine only usage for this item cursor.
22620     *
22621     * @param item widget item with cursor already set.
22622     * @return engine_only boolean to define it cursors should be looked only
22623     * between the provided by the engine or searched on widget's theme as well.
22624     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22625     *
22626     * @see elm_object_cursor_engine_only_get() for more details.
22627     * @see elm_diskselector_item_cursor_engine_only_set()
22628     *
22629     * @ingroup Diskselector
22630     */
22631    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22632
22633    /**
22634     * @}
22635     */
22636
22637    /**
22638     * @defgroup Colorselector Colorselector
22639     *
22640     * @{
22641     *
22642     * @image html img/widget/colorselector/preview-00.png
22643     * @image latex img/widget/colorselector/preview-00.eps
22644     *
22645     * @brief Widget for user to select a color.
22646     *
22647     * Signals that you can add callbacks for are:
22648     * "changed" - When the color value changes(event_info is NULL).
22649     *
22650     * See @ref tutorial_colorselector.
22651     */
22652    /**
22653     * @brief Add a new colorselector to the parent
22654     *
22655     * @param parent The parent object
22656     * @return The new object or NULL if it cannot be created
22657     *
22658     * @ingroup Colorselector
22659     */
22660    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22661    /**
22662     * Set a color for the colorselector
22663     *
22664     * @param obj   Colorselector object
22665     * @param r     r-value of color
22666     * @param g     g-value of color
22667     * @param b     b-value of color
22668     * @param a     a-value of color
22669     *
22670     * @ingroup Colorselector
22671     */
22672    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22673    /**
22674     * Get a color from the colorselector
22675     *
22676     * @param obj   Colorselector object
22677     * @param r     integer pointer for r-value of color
22678     * @param g     integer pointer for g-value of color
22679     * @param b     integer pointer for b-value of color
22680     * @param a     integer pointer for a-value of color
22681     *
22682     * @ingroup Colorselector
22683     */
22684    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22685    /**
22686     * @}
22687     */
22688
22689    /**
22690     * @defgroup Ctxpopup Ctxpopup
22691     *
22692     * @image html img/widget/ctxpopup/preview-00.png
22693     * @image latex img/widget/ctxpopup/preview-00.eps
22694     *
22695     * @brief Context popup widet.
22696     *
22697     * A ctxpopup is a widget that, when shown, pops up a list of items.
22698     * It automatically chooses an area inside its parent object's view
22699     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22700     * optimally fit into it. In the default theme, it will also point an
22701     * arrow to it's top left position at the time one shows it. Ctxpopup
22702     * items have a label and/or an icon. It is intended for a small
22703     * number of items (hence the use of list, not genlist).
22704     *
22705     * @note Ctxpopup is a especialization of @ref Hover.
22706     *
22707     * Signals that you can add callbacks for are:
22708     * "dismissed" - the ctxpopup was dismissed
22709     *
22710     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22711     * @{
22712     */
22713    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22714
22715    typedef enum _Elm_Ctxpopup_Direction
22716      {
22717         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22718                                           area */
22719         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22720                                            the clicked area */
22721         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22722                                           the clicked area */
22723         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22724                                         area */
22725      } Elm_Ctxpopup_Direction;
22726
22727    /**
22728     * @brief Add a new Ctxpopup object to the parent.
22729     *
22730     * @param parent Parent object
22731     * @return New object or @c NULL, if it cannot be created
22732     */
22733    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22734    /**
22735     * @brief Set the Ctxpopup's parent
22736     *
22737     * @param obj The ctxpopup object
22738     * @param area The parent to use
22739     *
22740     * Set the parent object.
22741     *
22742     * @note elm_ctxpopup_add() will automatically call this function
22743     * with its @c parent argument.
22744     *
22745     * @see elm_ctxpopup_add()
22746     * @see elm_hover_parent_set()
22747     */
22748    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22749    /**
22750     * @brief Get the Ctxpopup's parent
22751     *
22752     * @param obj The ctxpopup object
22753     *
22754     * @see elm_ctxpopup_hover_parent_set() for more information
22755     */
22756    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22757    /**
22758     * @brief Clear all items in the given ctxpopup object.
22759     *
22760     * @param obj Ctxpopup object
22761     */
22762    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22763    /**
22764     * @brief Change the ctxpopup's orientation to horizontal or vertical.
22765     *
22766     * @param obj Ctxpopup object
22767     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22768     */
22769    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22770    /**
22771     * @brief Get the value of current ctxpopup object's orientation.
22772     *
22773     * @param obj Ctxpopup object
22774     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22775     *
22776     * @see elm_ctxpopup_horizontal_set()
22777     */
22778    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22779    /**
22780     * @brief Add a new item to a ctxpopup object.
22781     *
22782     * @param obj Ctxpopup object
22783     * @param icon Icon to be set on new item
22784     * @param label The Label of the new item
22785     * @param func Convenience function called when item selected
22786     * @param data Data passed to @p func
22787     * @return A handle to the item added or @c NULL, on errors
22788     *
22789     * @warning Ctxpopup can't hold both an item list and a content at the same
22790     * time. When an item is added, any previous content will be removed.
22791     *
22792     * @see elm_ctxpopup_content_set()
22793     */
22794    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);
22795    /**
22796     * @brief Delete the given item in a ctxpopup object.
22797     *
22798     * @param item Ctxpopup item to be deleted
22799     *
22800     * @see elm_ctxpopup_item_append()
22801     */
22802    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22803    /**
22804     * @brief Set the ctxpopup item's state as disabled or enabled.
22805     *
22806     * @param item Ctxpopup item to be enabled/disabled
22807     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22808     *
22809     * When disabled the item is greyed out to indicate it's state.
22810     */
22811    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22812    /**
22813     * @brief Get the ctxpopup item's disabled/enabled state.
22814     *
22815     * @param item Ctxpopup item to be enabled/disabled
22816     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22817     *
22818     * @see elm_ctxpopup_item_disabled_set()
22819     */
22820    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22821    /**
22822     * @brief Get the icon object for the given ctxpopup item.
22823     *
22824     * @param item Ctxpopup item
22825     * @return icon object or @c NULL, if the item does not have icon or an error
22826     * occurred
22827     *
22828     * @see elm_ctxpopup_item_append()
22829     * @see elm_ctxpopup_item_icon_set()
22830     */
22831    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22832    /**
22833     * @brief Sets the side icon associated with the ctxpopup item
22834     *
22835     * @param item Ctxpopup item
22836     * @param icon Icon object to be set
22837     *
22838     * Once the icon object is set, a previously set one will be deleted.
22839     * @warning Setting the same icon for two items will cause the icon to
22840     * dissapear from the first item.
22841     *
22842     * @see elm_ctxpopup_item_append()
22843     */
22844    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22845    /**
22846     * @brief Get the label for the given ctxpopup item.
22847     *
22848     * @param item Ctxpopup item
22849     * @return label string or @c NULL, if the item does not have label or an
22850     * error occured
22851     *
22852     * @see elm_ctxpopup_item_append()
22853     * @see elm_ctxpopup_item_label_set()
22854     */
22855    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22856    /**
22857     * @brief (Re)set the label on the given ctxpopup item.
22858     *
22859     * @param item Ctxpopup item
22860     * @param label String to set as label
22861     */
22862    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22863    /**
22864     * @brief Set an elm widget as the content of the ctxpopup.
22865     *
22866     * @param obj Ctxpopup object
22867     * @param content Content to be swallowed
22868     *
22869     * If the content object is already set, a previous one will bedeleted. If
22870     * you want to keep that old content object, use the
22871     * elm_ctxpopup_content_unset() function.
22872     *
22873     * @deprecated use elm_object_content_set()
22874     *
22875     * @warning Ctxpopup can't hold both a item list and a content at the same
22876     * time. When a content is set, any previous items will be removed.
22877     */
22878    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22879    /**
22880     * @brief Unset the ctxpopup content
22881     *
22882     * @param obj Ctxpopup object
22883     * @return The content that was being used
22884     *
22885     * Unparent and return the content object which was set for this widget.
22886     *
22887     * @deprecated use elm_object_content_unset()
22888     *
22889     * @see elm_ctxpopup_content_set()
22890     */
22891    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22892    /**
22893     * @brief Set the direction priority of a ctxpopup.
22894     *
22895     * @param obj Ctxpopup object
22896     * @param first 1st priority of direction
22897     * @param second 2nd priority of direction
22898     * @param third 3th priority of direction
22899     * @param fourth 4th priority of direction
22900     *
22901     * This functions gives a chance to user to set the priority of ctxpopup
22902     * showing direction. This doesn't guarantee the ctxpopup will appear in the
22903     * requested direction.
22904     *
22905     * @see Elm_Ctxpopup_Direction
22906     */
22907    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);
22908    /**
22909     * @brief Get the direction priority of a ctxpopup.
22910     *
22911     * @param obj Ctxpopup object
22912     * @param first 1st priority of direction to be returned
22913     * @param second 2nd priority of direction to be returned
22914     * @param third 3th priority of direction to be returned
22915     * @param fourth 4th priority of direction to be returned
22916     *
22917     * @see elm_ctxpopup_direction_priority_set() for more information.
22918     */
22919    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);
22920    /**
22921     * @}
22922     */
22923
22924    /* transit */
22925    /**
22926     *
22927     * @defgroup Transit Transit
22928     * @ingroup Elementary
22929     *
22930     * Transit is designed to apply various animated transition effects to @c
22931     * Evas_Object, such like translation, rotation, etc. For using these
22932     * effects, create an @ref Elm_Transit and add the desired transition effects.
22933     *
22934     * Once the effects are added into transit, they will be automatically
22935     * managed (their callback will be called until the duration is ended, and
22936     * they will be deleted on completion).
22937     *
22938     * Example:
22939     * @code
22940     * Elm_Transit *trans = elm_transit_add();
22941     * elm_transit_object_add(trans, obj);
22942     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22943     * elm_transit_duration_set(transit, 1);
22944     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22945     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22946     * elm_transit_repeat_times_set(transit, 3);
22947     * @endcode
22948     *
22949     * Some transition effects are used to change the properties of objects. They
22950     * are:
22951     * @li @ref elm_transit_effect_translation_add
22952     * @li @ref elm_transit_effect_color_add
22953     * @li @ref elm_transit_effect_rotation_add
22954     * @li @ref elm_transit_effect_wipe_add
22955     * @li @ref elm_transit_effect_zoom_add
22956     * @li @ref elm_transit_effect_resizing_add
22957     *
22958     * Other transition effects are used to make one object disappear and another
22959     * object appear on its old place. These effects are:
22960     *
22961     * @li @ref elm_transit_effect_flip_add
22962     * @li @ref elm_transit_effect_resizable_flip_add
22963     * @li @ref elm_transit_effect_fade_add
22964     * @li @ref elm_transit_effect_blend_add
22965     *
22966     * It's also possible to make a transition chain with @ref
22967     * elm_transit_chain_transit_add.
22968     *
22969     * @warning We strongly recommend to use elm_transit just when edje can not do
22970     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22971     * animations can be manipulated inside the theme.
22972     *
22973     * List of examples:
22974     * @li @ref transit_example_01_explained
22975     * @li @ref transit_example_02_explained
22976     * @li @ref transit_example_03_c
22977     * @li @ref transit_example_04_c
22978     *
22979     * @{
22980     */
22981
22982    /**
22983     * @enum Elm_Transit_Tween_Mode
22984     *
22985     * The type of acceleration used in the transition.
22986     */
22987    typedef enum
22988      {
22989         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22990         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22991                                              over time, then decrease again
22992                                              and stop slowly */
22993         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22994                                              speed over time */
22995         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22996                                             over time */
22997      } Elm_Transit_Tween_Mode;
22998
22999    /**
23000     * @enum Elm_Transit_Effect_Flip_Axis
23001     *
23002     * The axis where flip effect should be applied.
23003     */
23004    typedef enum
23005      {
23006         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
23007         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
23008      } Elm_Transit_Effect_Flip_Axis;
23009    /**
23010     * @enum Elm_Transit_Effect_Wipe_Dir
23011     *
23012     * The direction where the wipe effect should occur.
23013     */
23014    typedef enum
23015      {
23016         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
23017         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
23018         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
23019         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
23020      } Elm_Transit_Effect_Wipe_Dir;
23021    /** @enum Elm_Transit_Effect_Wipe_Type
23022     *
23023     * Whether the wipe effect should show or hide the object.
23024     */
23025    typedef enum
23026      {
23027         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
23028                                              animation */
23029         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
23030                                             animation */
23031      } Elm_Transit_Effect_Wipe_Type;
23032
23033    /**
23034     * @typedef Elm_Transit
23035     *
23036     * The Transit created with elm_transit_add(). This type has the information
23037     * about the objects which the transition will be applied, and the
23038     * transition effects that will be used. It also contains info about
23039     * duration, number of repetitions, auto-reverse, etc.
23040     */
23041    typedef struct _Elm_Transit Elm_Transit;
23042    typedef void Elm_Transit_Effect;
23043    /**
23044     * @typedef Elm_Transit_Effect_Transition_Cb
23045     *
23046     * Transition callback called for this effect on each transition iteration.
23047     */
23048    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
23049    /**
23050     * Elm_Transit_Effect_End_Cb
23051     *
23052     * Transition callback called for this effect when the transition is over.
23053     */
23054    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
23055
23056    /**
23057     * Elm_Transit_Del_Cb
23058     *
23059     * A callback called when the transit is deleted.
23060     */
23061    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
23062
23063    /**
23064     * Add new transit.
23065     *
23066     * @note Is not necessary to delete the transit object, it will be deleted at
23067     * the end of its operation.
23068     * @note The transit will start playing when the program enter in the main loop, is not
23069     * necessary to give a start to the transit.
23070     *
23071     * @return The transit object.
23072     *
23073     * @ingroup Transit
23074     */
23075    EAPI Elm_Transit                *elm_transit_add(void);
23076
23077    /**
23078     * Stops the animation and delete the @p transit object.
23079     *
23080     * Call this function if you wants to stop the animation before the duration
23081     * time. Make sure the @p transit object is still alive with
23082     * elm_transit_del_cb_set() function.
23083     * All added effects will be deleted, calling its repective data_free_cb
23084     * functions. The function setted by elm_transit_del_cb_set() will be called.
23085     *
23086     * @see elm_transit_del_cb_set()
23087     *
23088     * @param transit The transit object to be deleted.
23089     *
23090     * @ingroup Transit
23091     * @warning Just call this function if you are sure the transit is alive.
23092     */
23093    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23094
23095    /**
23096     * Add a new effect to the transit.
23097     *
23098     * @note The cb function and the data are the key to the effect. If you try to
23099     * add an already added effect, nothing is done.
23100     * @note After the first addition of an effect in @p transit, if its
23101     * effect list become empty again, the @p transit will be killed by
23102     * elm_transit_del(transit) function.
23103     *
23104     * Exemple:
23105     * @code
23106     * Elm_Transit *transit = elm_transit_add();
23107     * elm_transit_effect_add(transit,
23108     *                        elm_transit_effect_blend_op,
23109     *                        elm_transit_effect_blend_context_new(),
23110     *                        elm_transit_effect_blend_context_free);
23111     * @endcode
23112     *
23113     * @param transit The transit object.
23114     * @param transition_cb The operation function. It is called when the
23115     * animation begins, it is the function that actually performs the animation.
23116     * It is called with the @p data, @p transit and the time progression of the
23117     * animation (a double value between 0.0 and 1.0).
23118     * @param effect The context data of the effect.
23119     * @param end_cb The function to free the context data, it will be called
23120     * at the end of the effect, it must finalize the animation and free the
23121     * @p data.
23122     *
23123     * @ingroup Transit
23124     * @warning The transit free the context data at the and of the transition with
23125     * the data_free_cb function, do not use the context data in another transit.
23126     */
23127    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);
23128
23129    /**
23130     * Delete an added effect.
23131     *
23132     * This function will remove the effect from the @p transit, calling the
23133     * data_free_cb to free the @p data.
23134     *
23135     * @see elm_transit_effect_add()
23136     *
23137     * @note If the effect is not found, nothing is done.
23138     * @note If the effect list become empty, this function will call
23139     * elm_transit_del(transit), that is, it will kill the @p transit.
23140     *
23141     * @param transit The transit object.
23142     * @param transition_cb The operation function.
23143     * @param effect The context data of the effect.
23144     *
23145     * @ingroup Transit
23146     */
23147    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);
23148
23149    /**
23150     * Add new object to apply the effects.
23151     *
23152     * @note After the first addition of an object in @p transit, if its
23153     * object list become empty again, the @p transit will be killed by
23154     * elm_transit_del(transit) function.
23155     * @note If the @p obj belongs to another transit, the @p obj will be
23156     * removed from it and it will only belong to the @p transit. If the old
23157     * transit stays without objects, it will die.
23158     * @note When you add an object into the @p transit, its state from
23159     * evas_object_pass_events_get(obj) is saved, and it is applied when the
23160     * transit ends, if you change this state whith evas_object_pass_events_set()
23161     * after add the object, this state will change again when @p transit stops to
23162     * run.
23163     *
23164     * @param transit The transit object.
23165     * @param obj Object to be animated.
23166     *
23167     * @ingroup Transit
23168     * @warning It is not allowed to add a new object after transit begins to go.
23169     */
23170    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23171
23172    /**
23173     * Removes an added object from the transit.
23174     *
23175     * @note If the @p obj is not in the @p transit, nothing is done.
23176     * @note If the list become empty, this function will call
23177     * elm_transit_del(transit), that is, it will kill the @p transit.
23178     *
23179     * @param transit The transit object.
23180     * @param obj Object to be removed from @p transit.
23181     *
23182     * @ingroup Transit
23183     * @warning It is not allowed to remove objects after transit begins to go.
23184     */
23185    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23186
23187    /**
23188     * Get the objects of the transit.
23189     *
23190     * @param transit The transit object.
23191     * @return a Eina_List with the objects from the transit.
23192     *
23193     * @ingroup Transit
23194     */
23195    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23196
23197    /**
23198     * Enable/disable keeping up the objects states.
23199     * If it is not kept, the objects states will be reset when transition ends.
23200     *
23201     * @note @p transit can not be NULL.
23202     * @note One state includes geometry, color, map data.
23203     *
23204     * @param transit The transit object.
23205     * @param state_keep Keeping or Non Keeping.
23206     *
23207     * @ingroup Transit
23208     */
23209    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23210
23211    /**
23212     * Get a value whether the objects states will be reset or not.
23213     *
23214     * @note @p transit can not be NULL
23215     *
23216     * @see elm_transit_objects_final_state_keep_set()
23217     *
23218     * @param transit The transit object.
23219     * @return EINA_TRUE means the states of the objects will be reset.
23220     * If @p transit is NULL, EINA_FALSE is returned
23221     *
23222     * @ingroup Transit
23223     */
23224    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23225
23226    /**
23227     * Set the event enabled when transit is operating.
23228     *
23229     * If @p enabled is EINA_TRUE, the objects of the transit will receives
23230     * events from mouse and keyboard during the animation.
23231     * @note When you add an object with elm_transit_object_add(), its state from
23232     * evas_object_pass_events_get(obj) is saved, and it is applied when the
23233     * transit ends, if you change this state with evas_object_pass_events_set()
23234     * after adding the object, this state will change again when @p transit stops
23235     * to run.
23236     *
23237     * @param transit The transit object.
23238     * @param enabled Events are received when enabled is @c EINA_TRUE, and
23239     * ignored otherwise.
23240     *
23241     * @ingroup Transit
23242     */
23243    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23244
23245    /**
23246     * Get the value of event enabled status.
23247     *
23248     * @see elm_transit_event_enabled_set()
23249     *
23250     * @param transit The Transit object
23251     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23252     * EINA_FALSE is returned
23253     *
23254     * @ingroup Transit
23255     */
23256    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23257
23258    /**
23259     * Set the user-callback function when the transit is deleted.
23260     *
23261     * @note Using this function twice will overwrite the first function setted.
23262     * @note the @p transit object will be deleted after call @p cb function.
23263     *
23264     * @param transit The transit object.
23265     * @param cb Callback function pointer. This function will be called before
23266     * the deletion of the transit.
23267     * @param data Callback funtion user data. It is the @p op parameter.
23268     *
23269     * @ingroup Transit
23270     */
23271    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23272
23273    /**
23274     * Set reverse effect automatically.
23275     *
23276     * If auto reverse is setted, after running the effects with the progress
23277     * parameter from 0 to 1, it will call the effecs again with the progress
23278     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23279     * where the duration was setted with the function elm_transit_add and
23280     * the repeat with the function elm_transit_repeat_times_set().
23281     *
23282     * @param transit The transit object.
23283     * @param reverse EINA_TRUE means the auto_reverse is on.
23284     *
23285     * @ingroup Transit
23286     */
23287    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23288
23289    /**
23290     * Get if the auto reverse is on.
23291     *
23292     * @see elm_transit_auto_reverse_set()
23293     *
23294     * @param transit The transit object.
23295     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23296     * EINA_FALSE is returned
23297     *
23298     * @ingroup Transit
23299     */
23300    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23301
23302    /**
23303     * Set the transit repeat count. Effect will be repeated by repeat count.
23304     *
23305     * This function sets the number of repetition the transit will run after
23306     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23307     * If the @p repeat is a negative number, it will repeat infinite times.
23308     *
23309     * @note If this function is called during the transit execution, the transit
23310     * will run @p repeat times, ignoring the times it already performed.
23311     *
23312     * @param transit The transit object
23313     * @param repeat Repeat count
23314     *
23315     * @ingroup Transit
23316     */
23317    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23318
23319    /**
23320     * Get the transit repeat count.
23321     *
23322     * @see elm_transit_repeat_times_set()
23323     *
23324     * @param transit The Transit object.
23325     * @return The repeat count. If @p transit is NULL
23326     * 0 is returned
23327     *
23328     * @ingroup Transit
23329     */
23330    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23331
23332    /**
23333     * Set the transit animation acceleration type.
23334     *
23335     * This function sets the tween mode of the transit that can be:
23336     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23337     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23338     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23339     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23340     *
23341     * @param transit The transit object.
23342     * @param tween_mode The tween type.
23343     *
23344     * @ingroup Transit
23345     */
23346    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23347
23348    /**
23349     * Get the transit animation acceleration type.
23350     *
23351     * @note @p transit can not be NULL
23352     *
23353     * @param transit The transit object.
23354     * @return The tween type. If @p transit is NULL
23355     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23356     *
23357     * @ingroup Transit
23358     */
23359    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23360
23361    /**
23362     * Set the transit animation time
23363     *
23364     * @note @p transit can not be NULL
23365     *
23366     * @param transit The transit object.
23367     * @param duration The animation time.
23368     *
23369     * @ingroup Transit
23370     */
23371    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23372
23373    /**
23374     * Get the transit animation time
23375     *
23376     * @note @p transit can not be NULL
23377     *
23378     * @param transit The transit object.
23379     *
23380     * @return The transit animation time.
23381     *
23382     * @ingroup Transit
23383     */
23384    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23385
23386    /**
23387     * Starts the transition.
23388     * Once this API is called, the transit begins to measure the time.
23389     *
23390     * @note @p transit can not be NULL
23391     *
23392     * @param transit The transit object.
23393     *
23394     * @ingroup Transit
23395     */
23396    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23397
23398    /**
23399     * Pause/Resume the transition.
23400     *
23401     * If you call elm_transit_go again, the transit will be started from the
23402     * beginning, and will be unpaused.
23403     *
23404     * @note @p transit can not be NULL
23405     *
23406     * @param transit The transit object.
23407     * @param paused Whether the transition should be paused or not.
23408     *
23409     * @ingroup Transit
23410     */
23411    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23412
23413    /**
23414     * Get the value of paused status.
23415     *
23416     * @see elm_transit_paused_set()
23417     *
23418     * @note @p transit can not be NULL
23419     *
23420     * @param transit The transit object.
23421     * @return EINA_TRUE means transition is paused. If @p transit is NULL
23422     * EINA_FALSE is returned
23423     *
23424     * @ingroup Transit
23425     */
23426    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23427
23428    /**
23429     * Get the time progression of the animation (a double value between 0.0 and 1.0).
23430     *
23431     * The value returned is a fraction (current time / total time). It
23432     * represents the progression position relative to the total.
23433     *
23434     * @note @p transit can not be NULL
23435     *
23436     * @param transit The transit object.
23437     *
23438     * @return The time progression value. If @p transit is NULL
23439     * 0 is returned
23440     *
23441     * @ingroup Transit
23442     */
23443    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23444
23445    /**
23446     * Makes the chain relationship between two transits.
23447     *
23448     * @note @p transit can not be NULL. Transit would have multiple chain transits.
23449     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23450     *
23451     * @param transit The transit object.
23452     * @param chain_transit The chain transit object. This transit will be operated
23453     *        after transit is done.
23454     *
23455     * This function adds @p chain_transit transition to a chain after the @p
23456     * transit, and will be started as soon as @p transit ends. See @ref
23457     * transit_example_02_explained for a full example.
23458     *
23459     * @ingroup Transit
23460     */
23461    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23462
23463    /**
23464     * Cut off the chain relationship between two transits.
23465     *
23466     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23467     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23468     *
23469     * @param transit The transit object.
23470     * @param chain_transit The chain transit object.
23471     *
23472     * This function remove the @p chain_transit transition from the @p transit.
23473     *
23474     * @ingroup Transit
23475     */
23476    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23477
23478    /**
23479     * Get the current chain transit list.
23480     *
23481     * @note @p transit can not be NULL.
23482     *
23483     * @param transit The transit object.
23484     * @return chain transit list.
23485     *
23486     * @ingroup Transit
23487     */
23488    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
23489
23490    /**
23491     * Add the Resizing Effect to Elm_Transit.
23492     *
23493     * @note This API is one of the facades. It creates resizing effect context
23494     * and add it's required APIs to elm_transit_effect_add.
23495     *
23496     * @see elm_transit_effect_add()
23497     *
23498     * @param transit Transit object.
23499     * @param from_w Object width size when effect begins.
23500     * @param from_h Object height size when effect begins.
23501     * @param to_w Object width size when effect ends.
23502     * @param to_h Object height size when effect ends.
23503     * @return Resizing effect context data.
23504     *
23505     * @ingroup Transit
23506     */
23507    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);
23508
23509    /**
23510     * Add the Translation Effect to Elm_Transit.
23511     *
23512     * @note This API is one of the facades. It creates translation effect context
23513     * and add it's required APIs to elm_transit_effect_add.
23514     *
23515     * @see elm_transit_effect_add()
23516     *
23517     * @param transit Transit object.
23518     * @param from_dx X Position variation when effect begins.
23519     * @param from_dy Y Position variation when effect begins.
23520     * @param to_dx X Position variation when effect ends.
23521     * @param to_dy Y Position variation when effect ends.
23522     * @return Translation effect context data.
23523     *
23524     * @ingroup Transit
23525     * @warning It is highly recommended just create a transit with this effect when
23526     * the window that the objects of the transit belongs has already been created.
23527     * This is because this effect needs the geometry information about the objects,
23528     * and if the window was not created yet, it can get a wrong information.
23529     */
23530    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);
23531
23532    /**
23533     * Add the Zoom Effect to Elm_Transit.
23534     *
23535     * @note This API is one of the facades. It creates zoom effect context
23536     * and add it's required APIs to elm_transit_effect_add.
23537     *
23538     * @see elm_transit_effect_add()
23539     *
23540     * @param transit Transit object.
23541     * @param from_rate Scale rate when effect begins (1 is current rate).
23542     * @param to_rate Scale rate when effect ends.
23543     * @return Zoom effect context data.
23544     *
23545     * @ingroup Transit
23546     * @warning It is highly recommended just create a transit with this effect when
23547     * the window that the objects of the transit belongs has already been created.
23548     * This is because this effect needs the geometry information about the objects,
23549     * and if the window was not created yet, it can get a wrong information.
23550     */
23551    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23552
23553    /**
23554     * Add the Flip Effect to Elm_Transit.
23555     *
23556     * @note This API is one of the facades. It creates flip effect context
23557     * and add it's required APIs to elm_transit_effect_add.
23558     * @note This effect is applied to each pair of objects in the order they are listed
23559     * in the transit list of objects. The first object in the pair will be the
23560     * "front" object and the second will be the "back" object.
23561     *
23562     * @see elm_transit_effect_add()
23563     *
23564     * @param transit Transit object.
23565     * @param axis Flipping Axis(X or Y).
23566     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23567     * @return Flip effect context data.
23568     *
23569     * @ingroup Transit
23570     * @warning It is highly recommended just create a transit with this effect when
23571     * the window that the objects of the transit belongs has already been created.
23572     * This is because this effect needs the geometry information about the objects,
23573     * and if the window was not created yet, it can get a wrong information.
23574     */
23575    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23576
23577    /**
23578     * Add the Resizable Flip Effect to Elm_Transit.
23579     *
23580     * @note This API is one of the facades. It creates resizable flip effect context
23581     * and add it's required APIs to elm_transit_effect_add.
23582     * @note This effect is applied to each pair of objects in the order they are listed
23583     * in the transit list of objects. The first object in the pair will be the
23584     * "front" object and the second will be the "back" object.
23585     *
23586     * @see elm_transit_effect_add()
23587     *
23588     * @param transit Transit object.
23589     * @param axis Flipping Axis(X or Y).
23590     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23591     * @return Resizable flip effect context data.
23592     *
23593     * @ingroup Transit
23594     * @warning It is highly recommended just create a transit with this effect when
23595     * the window that the objects of the transit belongs has already been created.
23596     * This is because this effect needs the geometry information about the objects,
23597     * and if the window was not created yet, it can get a wrong information.
23598     */
23599    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23600
23601    /**
23602     * Add the Wipe Effect to Elm_Transit.
23603     *
23604     * @note This API is one of the facades. It creates wipe effect context
23605     * and add it's required APIs to elm_transit_effect_add.
23606     *
23607     * @see elm_transit_effect_add()
23608     *
23609     * @param transit Transit object.
23610     * @param type Wipe type. Hide or show.
23611     * @param dir Wipe Direction.
23612     * @return Wipe effect context data.
23613     *
23614     * @ingroup Transit
23615     * @warning It is highly recommended just create a transit with this effect when
23616     * the window that the objects of the transit belongs has already been created.
23617     * This is because this effect needs the geometry information about the objects,
23618     * and if the window was not created yet, it can get a wrong information.
23619     */
23620    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23621
23622    /**
23623     * Add the Color Effect to Elm_Transit.
23624     *
23625     * @note This API is one of the facades. It creates color effect context
23626     * and add it's required APIs to elm_transit_effect_add.
23627     *
23628     * @see elm_transit_effect_add()
23629     *
23630     * @param transit        Transit object.
23631     * @param  from_r        RGB R when effect begins.
23632     * @param  from_g        RGB G when effect begins.
23633     * @param  from_b        RGB B when effect begins.
23634     * @param  from_a        RGB A when effect begins.
23635     * @param  to_r          RGB R when effect ends.
23636     * @param  to_g          RGB G when effect ends.
23637     * @param  to_b          RGB B when effect ends.
23638     * @param  to_a          RGB A when effect ends.
23639     * @return               Color effect context data.
23640     *
23641     * @ingroup Transit
23642     */
23643    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);
23644
23645    /**
23646     * Add the Fade Effect to Elm_Transit.
23647     *
23648     * @note This API is one of the facades. It creates fade effect context
23649     * and add it's required APIs to elm_transit_effect_add.
23650     * @note This effect is applied to each pair of objects in the order they are listed
23651     * in the transit list of objects. The first object in the pair will be the
23652     * "before" object and the second will be the "after" object.
23653     *
23654     * @see elm_transit_effect_add()
23655     *
23656     * @param transit Transit object.
23657     * @return Fade effect context data.
23658     *
23659     * @ingroup Transit
23660     * @warning It is highly recommended just create a transit with this effect when
23661     * the window that the objects of the transit belongs has already been created.
23662     * This is because this effect needs the color information about the objects,
23663     * and if the window was not created yet, it can get a wrong information.
23664     */
23665    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23666
23667    /**
23668     * Add the Blend Effect to Elm_Transit.
23669     *
23670     * @note This API is one of the facades. It creates blend effect context
23671     * and add it's required APIs to elm_transit_effect_add.
23672     * @note This effect is applied to each pair of objects in the order they are listed
23673     * in the transit list of objects. The first object in the pair will be the
23674     * "before" object and the second will be the "after" object.
23675     *
23676     * @see elm_transit_effect_add()
23677     *
23678     * @param transit Transit object.
23679     * @return Blend effect context data.
23680     *
23681     * @ingroup Transit
23682     * @warning It is highly recommended just create a transit with this effect when
23683     * the window that the objects of the transit belongs has already been created.
23684     * This is because this effect needs the color information about the objects,
23685     * and if the window was not created yet, it can get a wrong information.
23686     */
23687    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23688
23689    /**
23690     * Add the Rotation Effect to Elm_Transit.
23691     *
23692     * @note This API is one of the facades. It creates rotation effect context
23693     * and add it's required APIs to elm_transit_effect_add.
23694     *
23695     * @see elm_transit_effect_add()
23696     *
23697     * @param transit Transit object.
23698     * @param from_degree Degree when effect begins.
23699     * @param to_degree Degree when effect is ends.
23700     * @return Rotation effect context data.
23701     *
23702     * @ingroup Transit
23703     * @warning It is highly recommended just create a transit with this effect when
23704     * the window that the objects of the transit belongs has already been created.
23705     * This is because this effect needs the geometry information about the objects,
23706     * and if the window was not created yet, it can get a wrong information.
23707     */
23708    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23709
23710    /**
23711     * Add the ImageAnimation Effect to Elm_Transit.
23712     *
23713     * @note This API is one of the facades. It creates image animation effect context
23714     * and add it's required APIs to elm_transit_effect_add.
23715     * The @p images parameter is a list images paths. This list and
23716     * its contents will be deleted at the end of the effect by
23717     * elm_transit_effect_image_animation_context_free() function.
23718     *
23719     * Example:
23720     * @code
23721     * char buf[PATH_MAX];
23722     * Eina_List *images = NULL;
23723     * Elm_Transit *transi = elm_transit_add();
23724     *
23725     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23726     * images = eina_list_append(images, eina_stringshare_add(buf));
23727     *
23728     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23729     * images = eina_list_append(images, eina_stringshare_add(buf));
23730     * elm_transit_effect_image_animation_add(transi, images);
23731     *
23732     * @endcode
23733     *
23734     * @see elm_transit_effect_add()
23735     *
23736     * @param transit Transit object.
23737     * @param images Eina_List of images file paths. This list and
23738     * its contents will be deleted at the end of the effect by
23739     * elm_transit_effect_image_animation_context_free() function.
23740     * @return Image Animation effect context data.
23741     *
23742     * @ingroup Transit
23743     */
23744    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23745    /**
23746     * @}
23747     */
23748
23749   typedef struct _Elm_Store                      Elm_Store;
23750   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
23751   typedef struct _Elm_Store_Item                 Elm_Store_Item;
23752   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
23753   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
23754   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23755   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
23756   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
23757   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
23758   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
23759   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
23760
23761   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23762   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23763   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23764   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23765
23766   typedef enum
23767     {
23768        ELM_STORE_ITEM_MAPPING_NONE = 0,
23769        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23770        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23771        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23772        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23773        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23774        // can add more here as needed by common apps
23775        ELM_STORE_ITEM_MAPPING_LAST
23776     } Elm_Store_Item_Mapping_Type;
23777
23778   struct _Elm_Store_Item_Mapping_Icon
23779     {
23780        // FIXME: allow edje file icons
23781        int                   w, h;
23782        Elm_Icon_Lookup_Order lookup_order;
23783        Eina_Bool             standard_name : 1;
23784        Eina_Bool             no_scale : 1;
23785        Eina_Bool             smooth : 1;
23786        Eina_Bool             scale_up : 1;
23787        Eina_Bool             scale_down : 1;
23788     };
23789
23790   struct _Elm_Store_Item_Mapping_Empty
23791     {
23792        Eina_Bool             dummy;
23793     };
23794
23795   struct _Elm_Store_Item_Mapping_Photo
23796     {
23797        int                   size;
23798     };
23799
23800   struct _Elm_Store_Item_Mapping_Custom
23801     {
23802        Elm_Store_Item_Mapping_Cb func;
23803     };
23804
23805   struct _Elm_Store_Item_Mapping
23806     {
23807        Elm_Store_Item_Mapping_Type     type;
23808        const char                     *part;
23809        int                             offset;
23810        union
23811          {
23812             Elm_Store_Item_Mapping_Empty  empty;
23813             Elm_Store_Item_Mapping_Icon   icon;
23814             Elm_Store_Item_Mapping_Photo  photo;
23815             Elm_Store_Item_Mapping_Custom custom;
23816             // add more types here
23817          } details;
23818     };
23819
23820   struct _Elm_Store_Item_Info
23821     {
23822       Elm_Genlist_Item_Class       *item_class;
23823       const Elm_Store_Item_Mapping *mapping;
23824       void                         *data;
23825       char                         *sort_id;
23826     };
23827
23828   struct _Elm_Store_Item_Info_Filesystem
23829     {
23830       Elm_Store_Item_Info  base;
23831       char                *path;
23832     };
23833
23834 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23835 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23836
23837   EAPI void                    elm_store_free(Elm_Store *st);
23838
23839   EAPI Elm_Store              *elm_store_filesystem_new(void);
23840   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23841   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23842   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23843
23844   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23845
23846   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23847   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23848   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23849   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23850   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23851   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23852
23853   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23854   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23855   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23856   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23857   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23858   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23859   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23860
23861    /**
23862     * @defgroup SegmentControl SegmentControl
23863     * @ingroup Elementary
23864     *
23865     * @image html img/widget/segment_control/preview-00.png
23866     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23867     *
23868     * @image html img/segment_control.png
23869     * @image latex img/segment_control.eps width=\textwidth
23870     *
23871     * Segment control widget is a horizontal control made of multiple segment
23872     * items, each segment item functioning similar to discrete two state button.
23873     * A segment control groups the items together and provides compact
23874     * single button with multiple equal size segments.
23875     *
23876     * Segment item size is determined by base widget
23877     * size and the number of items added.
23878     * Only one segment item can be at selected state. A segment item can display
23879     * combination of Text and any Evas_Object like Images or other widget.
23880     *
23881     * Smart callbacks one can listen to:
23882     * - "changed" - When the user clicks on a segment item which is not
23883     *   previously selected and get selected. The event_info parameter is the
23884     *   segment item index.
23885     *
23886     * Available styles for it:
23887     * - @c "default"
23888     *
23889     * Here is an example on its usage:
23890     * @li @ref segment_control_example
23891     */
23892
23893    /**
23894     * @addtogroup SegmentControl
23895     * @{
23896     */
23897
23898    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23899
23900    /**
23901     * Add a new segment control widget to the given parent Elementary
23902     * (container) object.
23903     *
23904     * @param parent The parent object.
23905     * @return a new segment control widget handle or @c NULL, on errors.
23906     *
23907     * This function inserts a new segment control widget on the canvas.
23908     *
23909     * @ingroup SegmentControl
23910     */
23911    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23912
23913    /**
23914     * Append a new item to the segment control object.
23915     *
23916     * @param obj The segment control object.
23917     * @param icon The icon object to use for the left side of the item. An
23918     * icon can be any Evas object, but usually it is an icon created
23919     * with elm_icon_add().
23920     * @param label The label of the item.
23921     *        Note that, NULL is different from empty string "".
23922     * @return The created item or @c NULL upon failure.
23923     *
23924     * A new item will be created and appended to the segment control, i.e., will
23925     * be set as @b last item.
23926     *
23927     * If it should be inserted at another position,
23928     * elm_segment_control_item_insert_at() should be used instead.
23929     *
23930     * Items created with this function can be deleted with function
23931     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23932     *
23933     * @note @p label set to @c NULL is different from empty string "".
23934     * If an item
23935     * only has icon, it will be displayed bigger and centered. If it has
23936     * icon and label, even that an empty string, icon will be smaller and
23937     * positioned at left.
23938     *
23939     * Simple example:
23940     * @code
23941     * sc = elm_segment_control_add(win);
23942     * ic = elm_icon_add(win);
23943     * elm_icon_file_set(ic, "path/to/image", NULL);
23944     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23945     * elm_segment_control_item_add(sc, ic, "label");
23946     * evas_object_show(sc);
23947     * @endcode
23948     *
23949     * @see elm_segment_control_item_insert_at()
23950     * @see elm_segment_control_item_del()
23951     *
23952     * @ingroup SegmentControl
23953     */
23954    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23955
23956    /**
23957     * Insert a new item to the segment control object at specified position.
23958     *
23959     * @param obj The segment control object.
23960     * @param icon The icon object to use for the left side of the item. An
23961     * icon can be any Evas object, but usually it is an icon created
23962     * with elm_icon_add().
23963     * @param label The label of the item.
23964     * @param index Item position. Value should be between 0 and items count.
23965     * @return The created item or @c NULL upon failure.
23966
23967     * Index values must be between @c 0, when item will be prepended to
23968     * segment control, and items count, that can be get with
23969     * elm_segment_control_item_count_get(), case when item will be appended
23970     * to segment control, just like elm_segment_control_item_add().
23971     *
23972     * Items created with this function can be deleted with function
23973     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23974     *
23975     * @note @p label set to @c NULL is different from empty string "".
23976     * If an item
23977     * only has icon, it will be displayed bigger and centered. If it has
23978     * icon and label, even that an empty string, icon will be smaller and
23979     * positioned at left.
23980     *
23981     * @see elm_segment_control_item_add()
23982     * @see elm_segment_control_count_get()
23983     * @see elm_segment_control_item_del()
23984     *
23985     * @ingroup SegmentControl
23986     */
23987    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);
23988
23989    /**
23990     * Remove a segment control item from its parent, deleting it.
23991     *
23992     * @param it The item to be removed.
23993     *
23994     * Items can be added with elm_segment_control_item_add() or
23995     * elm_segment_control_item_insert_at().
23996     *
23997     * @ingroup SegmentControl
23998     */
23999    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24000
24001    /**
24002     * Remove a segment control item at given index from its parent,
24003     * deleting it.
24004     *
24005     * @param obj The segment control object.
24006     * @param index The position of the segment control item to be deleted.
24007     *
24008     * Items can be added with elm_segment_control_item_add() or
24009     * elm_segment_control_item_insert_at().
24010     *
24011     * @ingroup SegmentControl
24012     */
24013    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24014
24015    /**
24016     * Get the Segment items count from segment control.
24017     *
24018     * @param obj The segment control object.
24019     * @return Segment items count.
24020     *
24021     * It will just return the number of items added to segment control @p obj.
24022     *
24023     * @ingroup SegmentControl
24024     */
24025    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24026
24027    /**
24028     * Get the item placed at specified index.
24029     *
24030     * @param obj The segment control object.
24031     * @param index The index of the segment item.
24032     * @return The segment control item or @c NULL on failure.
24033     *
24034     * Index is the position of an item in segment control widget. Its
24035     * range is from @c 0 to <tt> count - 1 </tt>.
24036     * Count is the number of items, that can be get with
24037     * elm_segment_control_item_count_get().
24038     *
24039     * @ingroup SegmentControl
24040     */
24041    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24042
24043    /**
24044     * Get the label of item.
24045     *
24046     * @param obj The segment control object.
24047     * @param index The index of the segment item.
24048     * @return The label of the item at @p index.
24049     *
24050     * The return value is a pointer to the label associated to the item when
24051     * it was created, with function elm_segment_control_item_add(), or later
24052     * with function elm_segment_control_item_label_set. If no label
24053     * was passed as argument, it will return @c NULL.
24054     *
24055     * @see elm_segment_control_item_label_set() for more details.
24056     * @see elm_segment_control_item_add()
24057     *
24058     * @ingroup SegmentControl
24059     */
24060    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24061
24062    /**
24063     * Set the label of item.
24064     *
24065     * @param it The item of segment control.
24066     * @param text The label of item.
24067     *
24068     * The label to be displayed by the item.
24069     * Label will be at right of the icon (if set).
24070     *
24071     * If a label was passed as argument on item creation, with function
24072     * elm_control_segment_item_add(), it will be already
24073     * displayed by the item.
24074     *
24075     * @see elm_segment_control_item_label_get()
24076     * @see elm_segment_control_item_add()
24077     *
24078     * @ingroup SegmentControl
24079     */
24080    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
24081
24082    /**
24083     * Get the icon associated to the item.
24084     *
24085     * @param obj The segment control object.
24086     * @param index The index of the segment item.
24087     * @return The left side icon associated to the item at @p index.
24088     *
24089     * The return value is a pointer to the icon associated to the item when
24090     * it was created, with function elm_segment_control_item_add(), or later
24091     * with function elm_segment_control_item_icon_set(). If no icon
24092     * was passed as argument, it will return @c NULL.
24093     *
24094     * @see elm_segment_control_item_add()
24095     * @see elm_segment_control_item_icon_set()
24096     *
24097     * @ingroup SegmentControl
24098     */
24099    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24100
24101    /**
24102     * Set the icon associated to the item.
24103     *
24104     * @param it The segment control item.
24105     * @param icon The icon object to associate with @p it.
24106     *
24107     * The icon object to use at left side of the item. An
24108     * icon can be any Evas object, but usually it is an icon created
24109     * with elm_icon_add().
24110     *
24111     * Once the icon object is set, a previously set one will be deleted.
24112     * @warning Setting the same icon for two items will cause the icon to
24113     * dissapear from the first item.
24114     *
24115     * If an icon was passed as argument on item creation, with function
24116     * elm_segment_control_item_add(), it will be already
24117     * associated to the item.
24118     *
24119     * @see elm_segment_control_item_add()
24120     * @see elm_segment_control_item_icon_get()
24121     *
24122     * @ingroup SegmentControl
24123     */
24124    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24125
24126    /**
24127     * Get the index of an item.
24128     *
24129     * @param it The segment control item.
24130     * @return The position of item in segment control widget.
24131     *
24132     * Index is the position of an item in segment control widget. Its
24133     * range is from @c 0 to <tt> count - 1 </tt>.
24134     * Count is the number of items, that can be get with
24135     * elm_segment_control_item_count_get().
24136     *
24137     * @ingroup SegmentControl
24138     */
24139    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24140
24141    /**
24142     * Get the base object of the item.
24143     *
24144     * @param it The segment control item.
24145     * @return The base object associated with @p it.
24146     *
24147     * Base object is the @c Evas_Object that represents that item.
24148     *
24149     * @ingroup SegmentControl
24150     */
24151    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24152
24153    /**
24154     * Get the selected item.
24155     *
24156     * @param obj The segment control object.
24157     * @return The selected item or @c NULL if none of segment items is
24158     * selected.
24159     *
24160     * The selected item can be unselected with function
24161     * elm_segment_control_item_selected_set().
24162     *
24163     * The selected item always will be highlighted on segment control.
24164     *
24165     * @ingroup SegmentControl
24166     */
24167    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24168
24169    /**
24170     * Set the selected state of an item.
24171     *
24172     * @param it The segment control item
24173     * @param select The selected state
24174     *
24175     * This sets the selected state of the given item @p it.
24176     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24177     *
24178     * If a new item is selected the previosly selected will be unselected.
24179     * Previoulsy selected item can be get with function
24180     * elm_segment_control_item_selected_get().
24181     *
24182     * The selected item always will be highlighted on segment control.
24183     *
24184     * @see elm_segment_control_item_selected_get()
24185     *
24186     * @ingroup SegmentControl
24187     */
24188    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24189
24190    /**
24191     * @}
24192     */
24193
24194
24195    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24196    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
24197    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24198    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24199    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24200    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24201    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24202    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24203
24204
24205    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
24206    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
24207    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
24208    
24209    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24210    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24211    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24212    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24213    EAPI void elm_video_play(Evas_Object *video);
24214    EAPI void elm_video_pause(Evas_Object *video);
24215    EAPI void elm_video_stop(Evas_Object *video);
24216    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24217    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24218    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24219    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24220    EAPI double elm_video_audio_level_get(Evas_Object *video);
24221    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24222    EAPI double elm_video_play_position_get(Evas_Object *video);
24223    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24224    EAPI double elm_video_play_length_get(Evas_Object *video);
24225    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24226    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24227    EAPI const char *elm_video_title_get(Evas_Object *video);
24228
24229    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24230    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24231
24232   /* naviframe */
24233    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24234    EAPI Elm_Object_Item    *elm_naviframe_item_push(Evas_Object *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
24235    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24236    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24237    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24238    EAPI void                elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24239    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24240    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24241    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24242    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24243    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24244    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24245    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24246    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24247    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24248
24249 #ifdef __cplusplus
24250 }
24251 #endif
24252
24253 #endif