[Elementary.h] Update documentation for photo widget
[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 0.8.0
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 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name (hello) and title (Hello)
199    win = elm_win_util_standard_add("hello", "Hello");
200    // when the user clicks "close" on a window there is a request to delete
201    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
202
203    // add a box object - default is vertical. a box holds children in a row,
204    // either horizontally or vertically. nothing more.
205    box = elm_box_add(win);
206    // make the box hotizontal
207    elm_box_horizontal_set(box, EINA_TRUE);
208    // add object as a resize object for the window (controls window minimum
209    // size as well as gets resized if window is resized)
210    elm_win_resize_object_add(win, box);
211    evas_object_show(box);
212
213    // add a label widget, set the text and put it in the pad frame
214    lab = elm_label_add(win);
215    // set default text of the label
216    elm_object_text_set(lab, "Hello out there world!");
217    // pack the label at the end of the box
218    elm_box_pack_end(box, lab);
219    evas_object_show(lab);
220
221    // add an ok button
222    btn = elm_button_add(win);
223    // set default text of button to "OK"
224    elm_object_text_set(btn, "OK");
225    // pack the button at the end of the box
226    elm_box_pack_end(box, btn);
227    evas_object_show(btn);
228    // call on_done when button is clicked
229    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
230
231    // now we are done, show the window
232    evas_object_show(win);
233
234    // run the mainloop and process events and callbacks
235    elm_run();
236    return 0;
237 }
238 ELM_MAIN()
239 @endcode
240    *
241    */
242
243 /**
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
271 @author Tiago Falcão <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
294
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
297  */
298
299 #ifndef ELEMENTARY_H
300 #define ELEMENTARY_H
301
302 /**
303  * @file Elementary.h
304  * @brief Elementary's API
305  *
306  * Elementary API.
307  */
308
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_EMAP_DEF@ ELM_EMAP
316 @ELM_DEBUG_DEF@ ELM_DEBUG
317 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
318 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
319
320 /* Standard headers for standard system calls etc. */
321 #include <stdio.h>
322 #include <stdlib.h>
323 #include <unistd.h>
324 #include <string.h>
325 #include <sys/types.h>
326 #include <sys/stat.h>
327 #include <sys/time.h>
328 #include <sys/param.h>
329 #include <dlfcn.h>
330 #include <math.h>
331 #include <fnmatch.h>
332 #include <limits.h>
333 #include <ctype.h>
334 #include <time.h>
335 #include <dirent.h>
336 #include <pwd.h>
337 #include <errno.h>
338
339 #ifdef ELM_UNIX
340 # include <locale.h>
341 # ifdef ELM_LIBINTL_H
342 #  include <libintl.h>
343 # endif
344 # include <signal.h>
345 # include <grp.h>
346 # include <glob.h>
347 #endif
348
349 #ifdef ELM_ALLOCA_H
350 # include <alloca.h>
351 #endif
352
353 #if defined (ELM_WIN32) || defined (ELM_WINCE)
354 # include <malloc.h>
355 # ifndef alloca
356 #  define alloca _alloca
357 # endif
358 #endif
359
360
361 /* EFL headers */
362 #include <Eina.h>
363 #include <Eet.h>
364 #include <Evas.h>
365 #include <Evas_GL.h>
366 #include <Ecore.h>
367 #include <Ecore_Evas.h>
368 #include <Ecore_File.h>
369 #include <Ecore_IMF.h>
370 #include <Edje.h>
371
372 #ifdef ELM_EDBUS
373 # include <E_DBus.h>
374 #endif
375
376 #ifdef ELM_EFREET
377 # include <Efreet.h>
378 # include <Efreet_Mime.h>
379 # include <Efreet_Trash.h>
380 #endif
381
382 #ifdef ELM_ETHUMB
383 # include <Ethumb_Client.h>
384 #endif
385
386 #ifdef ELM_EMAP
387 # include <EMap.h>
388 #endif
389
390 #ifdef EAPI
391 # undef EAPI
392 #endif
393
394 #ifdef _WIN32
395 # ifdef ELEMENTARY_BUILD
396 #  ifdef DLL_EXPORT
397 #   define EAPI __declspec(dllexport)
398 #  else
399 #   define EAPI
400 #  endif /* ! DLL_EXPORT */
401 # else
402 #  define EAPI __declspec(dllimport)
403 # endif /* ! EFL_EVAS_BUILD */
404 #else
405 # ifdef __GNUC__
406 #  if __GNUC__ >= 4
407 #   define EAPI __attribute__ ((visibility("default")))
408 #  else
409 #   define EAPI
410 #  endif
411 # else
412 #  define EAPI
413 # endif
414 #endif /* ! _WIN32 */
415
416
417 /* allow usage from c++ */
418 #ifdef __cplusplus
419 extern "C" {
420 #endif
421
422 #define ELM_VERSION_MAJOR @VMAJ@
423 #define ELM_VERSION_MINOR @VMIN@
424
425    typedef struct _Elm_Version
426      {
427         int major;
428         int minor;
429         int micro;
430         int revision;
431      } Elm_Version;
432
433    EAPI extern Elm_Version *elm_version;
434
435 /* handy macros */
436 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
437 #define ELM_PI 3.14159265358979323846
438
439    /**
440     * @defgroup General General
441     *
442     * @brief General Elementary API. Functions that don't relate to
443     * Elementary objects specifically.
444     *
445     * Here are documented functions which init/shutdown the library,
446     * that apply to generic Elementary objects, that deal with
447     * configuration, et cetera.
448     *
449     * @ref general_functions_example_page "This" example contemplates
450     * some of these functions.
451     */
452
453    /**
454     * @addtogroup General
455     * @{
456     */
457
458   /**
459    * Defines couple of standard Evas_Object layers to be used
460    * with evas_object_layer_set().
461    *
462    * @note whenever extending with new values, try to keep some padding
463    *       to siblings so there is room for further extensions.
464    */
465   typedef enum _Elm_Object_Layer
466     {
467        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
468        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
469        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
470        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
471        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
472        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
473     } Elm_Object_Layer;
474
475 /**************************************************************************/
476    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
477
478    /**
479     * Emitted when any Elementary's policy value is changed.
480     */
481    EAPI extern int ELM_EVENT_POLICY_CHANGED;
482
483    /**
484     * @typedef Elm_Event_Policy_Changed
485     *
486     * Data on the event when an Elementary policy has changed
487     */
488     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
489
490    /**
491     * @struct _Elm_Event_Policy_Changed
492     *
493     * Data on the event when an Elementary policy has changed
494     */
495     struct _Elm_Event_Policy_Changed
496      {
497         unsigned int policy; /**< the policy identifier */
498         int          new_value; /**< value the policy had before the change */
499         int          old_value; /**< new value the policy got */
500     };
501
502    /**
503     * Policy identifiers.
504     */
505     typedef enum _Elm_Policy
506     {
507         ELM_POLICY_QUIT, /**< under which circumstances the application
508                           * should quit automatically. @see
509                           * Elm_Policy_Quit.
510                           */
511         ELM_POLICY_LAST
512     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
513  */
514
515    typedef enum _Elm_Policy_Quit
516      {
517         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
518                                    * automatically */
519         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
520                                             * application's last
521                                             * window is closed */
522      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
523
524    typedef enum _Elm_Focus_Direction
525      {
526         ELM_FOCUS_PREVIOUS,
527         ELM_FOCUS_NEXT
528      } Elm_Focus_Direction;
529
530    typedef enum _Elm_Text_Format
531      {
532         ELM_TEXT_FORMAT_PLAIN_UTF8,
533         ELM_TEXT_FORMAT_MARKUP_UTF8
534      } Elm_Text_Format;
535
536    /**
537     * Line wrapping types.
538     */
539    typedef enum _Elm_Wrap_Type
540      {
541         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
542         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
543         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
544         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
545         ELM_WRAP_LAST
546      } Elm_Wrap_Type;
547
548    typedef enum
549      {
550         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
551         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
552         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
553         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
554         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
555         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
556         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
557         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
558         ELM_INPUT_PANEL_LAYOUT_INVALID
559      } Elm_Input_Panel_Layout;
560
561    typedef enum
562      {
563         ELM_AUTOCAPITAL_TYPE_NONE,
564         ELM_AUTOCAPITAL_TYPE_WORD,
565         ELM_AUTOCAPITAL_TYPE_SENTENCE,
566         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
567      } Elm_Autocapital_Type;
568
569    /**
570     * @typedef Elm_Object_Item
571     * An Elementary Object item handle.
572     * @ingroup General
573     */
574    typedef struct _Elm_Object_Item Elm_Object_Item;
575
576
577    /**
578     * Called back when a widget's tooltip is activated and needs content.
579     * @param data user-data given to elm_object_tooltip_content_cb_set()
580     * @param obj owner widget.
581     */
582    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
583
584    /**
585     * Called back when a widget's item tooltip is activated and needs content.
586     * @param data user-data given to elm_object_tooltip_content_cb_set()
587     * @param obj owner widget.
588     * @param item context dependent item. As an example, if tooltip was
589     *        set on Elm_List_Item, then it is of this type.
590     */
591    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
592
593    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
594
595 #ifndef ELM_LIB_QUICKLAUNCH
596 #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 */
597 #else
598 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
599 #endif
600
601 /**************************************************************************/
602    /* General calls */
603
604    /**
605     * Initialize Elementary
606     *
607     * @param[in] argc System's argument count value
608     * @param[in] argv System's pointer to array of argument strings
609     * @return The init counter value.
610     *
611     * This function initializes Elementary and increments a counter of
612     * the number of calls to it. It returns the new counter's value.
613     *
614     * @warning This call is exported only for use by the @c ELM_MAIN()
615     * macro. There is no need to use this if you use this macro (which
616     * is highly advisable). An elm_main() should contain the entry
617     * point code for your application, having the same prototype as
618     * elm_init(), and @b not being static (putting the @c EAPI symbol
619     * in front of its type declaration is advisable). The @c
620     * ELM_MAIN() call should be placed just after it.
621     *
622     * Example:
623     * @dontinclude bg_example_01.c
624     * @skip static void
625     * @until ELM_MAIN
626     *
627     * See the full @ref bg_example_01_c "example".
628     *
629     * @see elm_shutdown().
630     * @ingroup General
631     */
632    EAPI int          elm_init(int argc, char **argv);
633
634    /**
635     * Shut down Elementary
636     *
637     * @return The init counter value.
638     *
639     * This should be called at the end of your application, just
640     * before it ceases to do any more processing. This will clean up
641     * any permanent resources your application may have allocated via
642     * Elementary that would otherwise persist.
643     *
644     * @see elm_init() for an example
645     *
646     * @ingroup General
647     */
648    EAPI int          elm_shutdown(void);
649
650    /**
651     * Run Elementary's main loop
652     *
653     * This call should be issued just after all initialization is
654     * completed. This function will not return until elm_exit() is
655     * called. It will keep looping, running the main
656     * (event/processing) loop for Elementary.
657     *
658     * @see elm_init() for an example
659     *
660     * @ingroup General
661     */
662    EAPI void         elm_run(void);
663
664    /**
665     * Exit Elementary's main loop
666     *
667     * If this call is issued, it will flag the main loop to cease
668     * processing and return back to its parent function (usually your
669     * elm_main() function).
670     *
671     * @see elm_init() for an example. There, just after a request to
672     * close the window comes, the main loop will be left.
673     *
674     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
675     * applications, you'll be able to get this function called automatically for you.
676     *
677     * @ingroup General
678     */
679    EAPI void         elm_exit(void);
680
681    /**
682     * Provide information in order to make Elementary determine the @b
683     * run time location of the software in question, so other data files
684     * such as images, sound files, executable utilities, libraries,
685     * modules and locale files can be found.
686     *
687     * @param mainfunc This is your application's main function name,
688     *        whose binary's location is to be found. Providing @c NULL
689     *        will make Elementary not to use it
690     * @param dom This will be used as the application's "domain", in the
691     *        form of a prefix to any environment variables that may
692     *        override prefix detection and the directory name, inside the
693     *        standard share or data directories, where the software's
694     *        data files will be looked for.
695     * @param checkfile This is an (optional) magic file's path to check
696     *        for existence (and it must be located in the data directory,
697     *        under the share directory provided above). Its presence will
698     *        help determine the prefix found was correct. Pass @c NULL if
699     *        the check is not to be done.
700     *
701     * This function allows one to re-locate the application somewhere
702     * else after compilation, if the developer wishes for easier
703     * distribution of pre-compiled binaries.
704     *
705     * The prefix system is designed to locate where the given software is
706     * installed (under a common path prefix) at run time and then report
707     * specific locations of this prefix and common directories inside
708     * this prefix like the binary, library, data and locale directories,
709     * through the @c elm_app_*_get() family of functions.
710     *
711     * Call elm_app_info_set() early on before you change working
712     * directory or anything about @c argv[0], so it gets accurate
713     * information.
714     *
715     * It will then try and trace back which file @p mainfunc comes from,
716     * if provided, to determine the application's prefix directory.
717     *
718     * The @p dom parameter provides a string prefix to prepend before
719     * environment variables, allowing a fallback to @b specific
720     * environment variables to locate the software. You would most
721     * probably provide a lowercase string there, because it will also
722     * serve as directory domain, explained next. For environment
723     * variables purposes, this string is made uppercase. For example if
724     * @c "myapp" is provided as the prefix, then the program would expect
725     * @c "MYAPP_PREFIX" as a master environment variable to specify the
726     * exact install prefix for the software, or more specific environment
727     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
728     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
729     * the user or scripts before launching. If not provided (@c NULL),
730     * environment variables will not be used to override compiled-in
731     * defaults or auto detections.
732     *
733     * The @p dom string also provides a subdirectory inside the system
734     * shared data directory for data files. For example, if the system
735     * directory is @c /usr/local/share, then this directory name is
736     * appended, creating @c /usr/local/share/myapp, if it @p was @c
737     * "myapp". It is expected that the application installs data files in
738     * this directory.
739     *
740     * The @p checkfile is a file name or path of something inside the
741     * share or data directory to be used to test that the prefix
742     * detection worked. For example, your app will install a wallpaper
743     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
744     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
745     * checkfile string.
746     *
747     * @see elm_app_compile_bin_dir_set()
748     * @see elm_app_compile_lib_dir_set()
749     * @see elm_app_compile_data_dir_set()
750     * @see elm_app_compile_locale_set()
751     * @see elm_app_prefix_dir_get()
752     * @see elm_app_bin_dir_get()
753     * @see elm_app_lib_dir_get()
754     * @see elm_app_data_dir_get()
755     * @see elm_app_locale_dir_get()
756     */
757    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
758
759    /**
760     * Provide information on the @b fallback application's binaries
761     * directory, in scenarios where they get overriden by
762     * elm_app_info_set().
763     *
764     * @param dir The path to the default binaries directory (compile time
765     * one)
766     *
767     * @note Elementary will as well use this path to determine actual
768     * names of binaries' directory paths, maybe changing it to be @c
769     * something/local/bin instead of @c something/bin, only, for
770     * example.
771     *
772     * @warning You should call this function @b before
773     * elm_app_info_set().
774     */
775    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
776
777    /**
778     * Provide information on the @b fallback application's libraries
779     * directory, on scenarios where they get overriden by
780     * elm_app_info_set().
781     *
782     * @param dir The path to the default libraries directory (compile
783     * time one)
784     *
785     * @note Elementary will as well use this path to determine actual
786     * names of libraries' directory paths, maybe changing it to be @c
787     * something/lib32 or @c something/lib64 instead of @c something/lib,
788     * only, for example.
789     *
790     * @warning You should call this function @b before
791     * elm_app_info_set().
792     */
793    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
794
795    /**
796     * Provide information on the @b fallback application's data
797     * directory, on scenarios where they get overriden by
798     * elm_app_info_set().
799     *
800     * @param dir The path to the default data directory (compile time
801     * one)
802     *
803     * @note Elementary will as well use this path to determine actual
804     * names of data directory paths, maybe changing it to be @c
805     * something/local/share instead of @c something/share, only, for
806     * example.
807     *
808     * @warning You should call this function @b before
809     * elm_app_info_set().
810     */
811    EAPI void         elm_app_compile_data_dir_set(const char *dir);
812
813    /**
814     * Provide information on the @b fallback application's locale
815     * directory, on scenarios where they get overriden by
816     * elm_app_info_set().
817     *
818     * @param dir The path to the default locale directory (compile time
819     * one)
820     *
821     * @warning You should call this function @b before
822     * elm_app_info_set().
823     */
824    EAPI void         elm_app_compile_locale_set(const char *dir);
825
826    /**
827     * Retrieve the application's run time prefix directory, as set by
828     * elm_app_info_set() and the way (environment) the application was
829     * run from.
830     *
831     * @return The directory prefix the application is actually using.
832     */
833    EAPI const char  *elm_app_prefix_dir_get(void);
834
835    /**
836     * Retrieve the application's run time binaries prefix directory, as
837     * set by elm_app_info_set() and the way (environment) the application
838     * was run from.
839     *
840     * @return The binaries directory prefix the application is actually
841     * using.
842     */
843    EAPI const char  *elm_app_bin_dir_get(void);
844
845    /**
846     * Retrieve the application's run time libraries prefix directory, as
847     * set by elm_app_info_set() and the way (environment) the application
848     * was run from.
849     *
850     * @return The libraries directory prefix the application is actually
851     * using.
852     */
853    EAPI const char  *elm_app_lib_dir_get(void);
854
855    /**
856     * Retrieve the application's run time data prefix directory, as
857     * set by elm_app_info_set() and the way (environment) the application
858     * was run from.
859     *
860     * @return The data directory prefix the application is actually
861     * using.
862     */
863    EAPI const char  *elm_app_data_dir_get(void);
864
865    /**
866     * Retrieve the application's run time locale prefix directory, as
867     * set by elm_app_info_set() and the way (environment) the application
868     * was run from.
869     *
870     * @return The locale directory prefix the application is actually
871     * using.
872     */
873    EAPI const char  *elm_app_locale_dir_get(void);
874
875    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
876    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
877    EAPI int          elm_quicklaunch_init(int argc, char **argv);
878    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
879    EAPI int          elm_quicklaunch_sub_shutdown(void);
880    EAPI int          elm_quicklaunch_shutdown(void);
881    EAPI void         elm_quicklaunch_seed(void);
882    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
883    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
884    EAPI void         elm_quicklaunch_cleanup(void);
885    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
886    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
887
888    EAPI Eina_Bool    elm_need_efreet(void);
889    EAPI Eina_Bool    elm_need_e_dbus(void);
890    EAPI Eina_Bool    elm_need_ethumb(void);
891
892    /**
893     * Set a new policy's value (for a given policy group/identifier).
894     *
895     * @param policy policy identifier, as in @ref Elm_Policy.
896     * @param value policy value, which depends on the identifier
897     *
898     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
899     *
900     * Elementary policies define applications' behavior,
901     * somehow. These behaviors are divided in policy groups (see
902     * #Elm_Policy enumeration). This call will emit the Ecore event
903     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
904     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
905     * then.
906     *
907     * @note Currently, we have only one policy identifier/group
908     * (#ELM_POLICY_QUIT), which has two possible values.
909     *
910     * @ingroup General
911     */
912    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
913
914    /**
915     * Gets the policy value for given policy identifier.
916     *
917     * @param policy policy identifier, as in #Elm_Policy.
918     * @return The currently set policy value, for that
919     * identifier. Will be @c 0 if @p policy passed is invalid.
920     *
921     * @ingroup General
922     */
923    EAPI int          elm_policy_get(unsigned int policy);
924
925    /**
926     * Change the language of the current application
927     *
928     * The @p lang passed must be the full name of the locale to use, for
929     * example "en_US.utf8" or "es_ES@euro".
930     *
931     * Changing language with this function will make Elementary run through
932     * all its widgets, translating strings set with
933     * elm_object_domain_translatable_text_part_set(). This way, an entire
934     * UI can have its language changed without having to restart the program.
935     *
936     * For more complex cases, like having formatted strings that need
937     * translation, widgets will also emit a "language,changed" signal that
938     * the user can listen to to manually translate the text.
939     *
940     * @param lang Language to set, must be the full name of the locale
941     *
942     * @ingroup General
943     */
944    EAPI void         elm_language_set(const char *lang);
945
946    /**
947     * Set a label of an object
948     *
949     * @param obj The Elementary object
950     * @param part The text part name to set (NULL for the default label)
951     * @param label The new text of the label
952     *
953     * @note Elementary objects may have many labels (e.g. Action Slider)
954     *
955     * @ingroup General
956     */
957    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
958
959 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
960
961    /**
962     * Get a label of an object
963     *
964     * @param obj The Elementary object
965     * @param part The text part name to get (NULL for the default label)
966     * @return text of the label or NULL for any error
967     *
968     * @note Elementary objects may have many labels (e.g. Action Slider)
969     *
970     * @ingroup General
971     */
972    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
973
974 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
975
976    /**
977     * Set a content of an object
978     *
979     * @param obj The Elementary object
980     * @param part The content part name to set (NULL for the default content)
981     * @param content The new content of the object
982     *
983     * @note Elementary objects may have many contents
984     *
985     * @ingroup General
986     */
987    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
988
989 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
990
991    /**
992     * Get a content of an object
993     *
994     * @param obj The Elementary object
995     * @param item The content part name to get (NULL for the default content)
996     * @return content of the object or NULL for any error
997     *
998     * @note Elementary objects may have many contents
999     *
1000     * @ingroup General
1001     */
1002    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1003
1004 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1005
1006    /**
1007     * Unset a content of an object
1008     *
1009     * @param obj The Elementary object
1010     * @param item The content part name to unset (NULL for the default content)
1011     *
1012     * @note Elementary objects may have many contents
1013     *
1014     * @ingroup General
1015     */
1016    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1017
1018 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1019
1020    /**
1021     * Set a content of an object item
1022     *
1023     * @param it The Elementary object item
1024     * @param part The content part name to set (NULL for the default content)
1025     * @param content The new content of the object item
1026     *
1027     * @note Elementary object items may have many contents
1028     *
1029     * @ingroup General
1030     */
1031    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1032
1033 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1034
1035    /**
1036     * Get a content of an object item
1037     *
1038     * @param it The Elementary object item
1039     * @param part The content part name to unset (NULL for the default content)
1040     * @return content of the object item or NULL for any error
1041     *
1042     * @note Elementary object items may have many contents
1043     *
1044     * @ingroup General
1045     */
1046    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1047
1048 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1049
1050    /**
1051     * Unset a content of an object item
1052     *
1053     * @param it The Elementary object item
1054     * @param part The content part name to unset (NULL for the default content)
1055     *
1056     * @note Elementary object items may have many contents
1057     *
1058     * @ingroup General
1059     */
1060    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1061
1062 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1063
1064    /**
1065     * Set a label of an object item
1066     *
1067     * @param it The Elementary object item
1068     * @param part The text part name to set (NULL for the default label)
1069     * @param label The new text of the label
1070     *
1071     * @note Elementary object items may have many labels
1072     *
1073     * @ingroup General
1074     */
1075    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1076
1077 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1078
1079    /**
1080     * Get a label of an object item
1081     *
1082     * @param it The Elementary object item
1083     * @param part The text part name to get (NULL for the default label)
1084     * @return text of the label or NULL for any error
1085     *
1086     * @note Elementary object items may have many labels
1087     *
1088     * @ingroup General
1089     */
1090    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1091
1092 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1093
1094    /**
1095     * Set the text to read out when in accessibility mode
1096     *
1097     * @param obj The object which is to be described
1098     * @param txt The text that describes the widget to people with poor or no vision
1099     *
1100     * @ingroup General
1101     */
1102    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1103
1104    /**
1105     * Set the text to read out when in accessibility mode
1106     *
1107     * @param it The object item which is to be described
1108     * @param txt The text that describes the widget to people with poor or no vision
1109     *
1110     * @ingroup General
1111     */
1112    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1113
1114    /**
1115     * Get the data associated with an object item
1116     * @param it The object item
1117     * @return The data associated with @p it
1118     *
1119     * @ingroup General
1120     */
1121    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1122
1123    /**
1124     * Set the data associated with an object item
1125     * @param it The object item
1126     * @param data The data to be associated with @p it
1127     *
1128     * @ingroup General
1129     */
1130    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1131
1132    /**
1133     * Send a signal to the edje object of the widget item.
1134     *
1135     * This function sends a signal to the edje object of the obj item. An
1136     * edje program can respond to a signal by specifying matching
1137     * 'signal' and 'source' fields.
1138     *
1139     * @param it The Elementary object item
1140     * @param emission The signal's name.
1141     * @param source The signal's source.
1142     * @ingroup General
1143     */
1144    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1145
1146    /**
1147     * @}
1148     */
1149
1150    /**
1151     * @defgroup Caches Caches
1152     *
1153     * These are functions which let one fine-tune some cache values for
1154     * Elementary applications, thus allowing for performance adjustments.
1155     *
1156     * @{
1157     */
1158
1159    /**
1160     * @brief Flush all caches.
1161     *
1162     * Frees all data that was in cache and is not currently being used to reduce
1163     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1164     * to calling all of the following functions:
1165     * @li edje_file_cache_flush()
1166     * @li edje_collection_cache_flush()
1167     * @li eet_clearcache()
1168     * @li evas_image_cache_flush()
1169     * @li evas_font_cache_flush()
1170     * @li evas_render_dump()
1171     * @note Evas caches are flushed for every canvas associated with a window.
1172     *
1173     * @ingroup Caches
1174     */
1175    EAPI void         elm_all_flush(void);
1176
1177    /**
1178     * Get the configured cache flush interval time
1179     *
1180     * This gets the globally configured cache flush interval time, in
1181     * ticks
1182     *
1183     * @return The cache flush interval time
1184     * @ingroup Caches
1185     *
1186     * @see elm_all_flush()
1187     */
1188    EAPI int          elm_cache_flush_interval_get(void);
1189
1190    /**
1191     * Set the configured cache flush interval time
1192     *
1193     * This sets the globally configured cache flush interval time, in ticks
1194     *
1195     * @param size The cache flush interval time
1196     * @ingroup Caches
1197     *
1198     * @see elm_all_flush()
1199     */
1200    EAPI void         elm_cache_flush_interval_set(int size);
1201
1202    /**
1203     * Set the configured cache flush interval time for all applications on the
1204     * display
1205     *
1206     * This sets the globally configured cache flush interval time -- in ticks
1207     * -- for all applications on the display.
1208     *
1209     * @param size The cache flush interval time
1210     * @ingroup Caches
1211     */
1212    EAPI void         elm_cache_flush_interval_all_set(int size);
1213
1214    /**
1215     * Get the configured cache flush enabled state
1216     *
1217     * This gets the globally configured cache flush state - if it is enabled
1218     * or not. When cache flushing is enabled, elementary will regularly
1219     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1220     * memory and allow usage to re-seed caches and data in memory where it
1221     * can do so. An idle application will thus minimise its memory usage as
1222     * data will be freed from memory and not be re-loaded as it is idle and
1223     * not rendering or doing anything graphically right now.
1224     *
1225     * @return The cache flush state
1226     * @ingroup Caches
1227     *
1228     * @see elm_all_flush()
1229     */
1230    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1231
1232    /**
1233     * Set the configured cache flush enabled state
1234     *
1235     * This sets the globally configured cache flush enabled state.
1236     *
1237     * @param size The cache flush enabled state
1238     * @ingroup Caches
1239     *
1240     * @see elm_all_flush()
1241     */
1242    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1243
1244    /**
1245     * Set the configured cache flush enabled state for all applications on the
1246     * display
1247     *
1248     * This sets the globally configured cache flush enabled state for all
1249     * applications on the display.
1250     *
1251     * @param size The cache flush enabled state
1252     * @ingroup Caches
1253     */
1254    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1255
1256    /**
1257     * Get the configured font cache size
1258     *
1259     * This gets the globally configured font cache size, in bytes.
1260     *
1261     * @return The font cache size
1262     * @ingroup Caches
1263     */
1264    EAPI int          elm_font_cache_get(void);
1265
1266    /**
1267     * Set the configured font cache size
1268     *
1269     * This sets the globally configured font cache size, in bytes
1270     *
1271     * @param size The font cache size
1272     * @ingroup Caches
1273     */
1274    EAPI void         elm_font_cache_set(int size);
1275
1276    /**
1277     * Set the configured font cache size for all applications on the
1278     * display
1279     *
1280     * This sets the globally configured font cache size -- in bytes
1281     * -- for all applications on the display.
1282     *
1283     * @param size The font cache size
1284     * @ingroup Caches
1285     */
1286    EAPI void         elm_font_cache_all_set(int size);
1287
1288    /**
1289     * Get the configured image cache size
1290     *
1291     * This gets the globally configured image cache size, in bytes
1292     *
1293     * @return The image cache size
1294     * @ingroup Caches
1295     */
1296    EAPI int          elm_image_cache_get(void);
1297
1298    /**
1299     * Set the configured image cache size
1300     *
1301     * This sets the globally configured image cache size, in bytes
1302     *
1303     * @param size The image cache size
1304     * @ingroup Caches
1305     */
1306    EAPI void         elm_image_cache_set(int size);
1307
1308    /**
1309     * Set the configured image cache size for all applications on the
1310     * display
1311     *
1312     * This sets the globally configured image cache size -- in bytes
1313     * -- for all applications on the display.
1314     *
1315     * @param size The image cache size
1316     * @ingroup Caches
1317     */
1318    EAPI void         elm_image_cache_all_set(int size);
1319
1320    /**
1321     * Get the configured edje file cache size.
1322     *
1323     * This gets the globally configured edje file cache size, in number
1324     * of files.
1325     *
1326     * @return The edje file cache size
1327     * @ingroup Caches
1328     */
1329    EAPI int          elm_edje_file_cache_get(void);
1330
1331    /**
1332     * Set the configured edje file cache size
1333     *
1334     * This sets the globally configured edje file cache size, in number
1335     * of files.
1336     *
1337     * @param size The edje file cache size
1338     * @ingroup Caches
1339     */
1340    EAPI void         elm_edje_file_cache_set(int size);
1341
1342    /**
1343     * Set the configured edje file cache size for all applications on the
1344     * display
1345     *
1346     * This sets the globally configured edje file cache size -- in number
1347     * of files -- for all applications on the display.
1348     *
1349     * @param size The edje file cache size
1350     * @ingroup Caches
1351     */
1352    EAPI void         elm_edje_file_cache_all_set(int size);
1353
1354    /**
1355     * Get the configured edje collections (groups) cache size.
1356     *
1357     * This gets the globally configured edje collections cache size, in
1358     * number of collections.
1359     *
1360     * @return The edje collections cache size
1361     * @ingroup Caches
1362     */
1363    EAPI int          elm_edje_collection_cache_get(void);
1364
1365    /**
1366     * Set the configured edje collections (groups) cache size
1367     *
1368     * This sets the globally configured edje collections cache size, in
1369     * number of collections.
1370     *
1371     * @param size The edje collections cache size
1372     * @ingroup Caches
1373     */
1374    EAPI void         elm_edje_collection_cache_set(int size);
1375
1376    /**
1377     * Set the configured edje collections (groups) cache size for all
1378     * applications on the display
1379     *
1380     * This sets the globally configured edje collections cache size -- in
1381     * number of collections -- for all applications on the display.
1382     *
1383     * @param size The edje collections cache size
1384     * @ingroup Caches
1385     */
1386    EAPI void         elm_edje_collection_cache_all_set(int size);
1387
1388    /**
1389     * @}
1390     */
1391
1392    /**
1393     * @defgroup Scaling Widget Scaling
1394     *
1395     * Different widgets can be scaled independently. These functions
1396     * allow you to manipulate this scaling on a per-widget basis. The
1397     * object and all its children get their scaling factors multiplied
1398     * by the scale factor set. This is multiplicative, in that if a
1399     * child also has a scale size set it is in turn multiplied by its
1400     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1401     * double size, @c 0.5 is half, etc.
1402     *
1403     * @ref general_functions_example_page "This" example contemplates
1404     * some of these functions.
1405     */
1406
1407    /**
1408     * Set the scaling factor for a given Elementary object
1409     *
1410     * @param obj The Elementary to operate on
1411     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1412     * no scaling)
1413     *
1414     * @ingroup Scaling
1415     */
1416    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1417
1418    /**
1419     * Get the scaling factor for a given Elementary object
1420     *
1421     * @param obj The object
1422     * @return The scaling factor set by elm_object_scale_set()
1423     *
1424     * @ingroup Scaling
1425     */
1426    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1427
1428    /**
1429     * @defgroup Password_last_show Password last input show
1430     *
1431     * Last show feature of password mode enables user to view
1432     * the last input entered for few seconds before masking it.
1433     * These functions allow to set this feature in password mode
1434     * of entry widget and also allow to manipulate the duration
1435     * for which the input has to be visible.
1436     *
1437     * @{
1438     */
1439
1440    /**
1441     * Get show last setting of password mode.
1442     *
1443     * This gets the show last input setting of password mode which might be
1444     * enabled or disabled.
1445     *
1446     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1447     *            if it's disabled.
1448     * @ingroup Password_last_show
1449     */
1450    EAPI Eina_Bool elm_password_show_last_get(void);
1451
1452    /**
1453     * Set show last setting in password mode.
1454     *
1455     * This enables or disables show last setting of password mode.
1456     *
1457     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1458     * @see elm_password_show_last_timeout_set()
1459     * @ingroup Password_last_show
1460     */
1461    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1462
1463    /**
1464     * Get's the timeout value in last show password mode.
1465     *
1466     * This gets the time out value for which the last input entered in password
1467     * mode will be visible.
1468     *
1469     * @return The timeout value of last show password mode.
1470     * @ingroup Password_last_show
1471     */
1472    EAPI double elm_password_show_last_timeout_get(void);
1473
1474    /**
1475     * Set's the timeout value in last show password mode.
1476     *
1477     * This sets the time out value for which the last input entered in password
1478     * mode will be visible.
1479     *
1480     * @param password_show_last_timeout The timeout value.
1481     * @see elm_password_show_last_set()
1482     * @ingroup Password_last_show
1483     */
1484    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1485
1486    /**
1487     * @}
1488     */
1489
1490    /**
1491     * @defgroup UI-Mirroring Selective Widget mirroring
1492     *
1493     * These functions allow you to set ui-mirroring on specific
1494     * widgets or the whole interface. Widgets can be in one of two
1495     * modes, automatic and manual.  Automatic means they'll be changed
1496     * according to the system mirroring mode and manual means only
1497     * explicit changes will matter. You are not supposed to change
1498     * mirroring state of a widget set to automatic, will mostly work,
1499     * but the behavior is not really defined.
1500     *
1501     * @{
1502     */
1503
1504    /**
1505     * Get the system mirrored mode. This determines the default mirrored mode
1506     * of widgets.
1507     *
1508     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1509     */
1510    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1511
1512    /**
1513     * Set the system mirrored mode. This determines the default mirrored mode
1514     * of widgets.
1515     *
1516     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1517     */
1518    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1519
1520    /**
1521     * Returns the widget's mirrored mode setting.
1522     *
1523     * @param obj The widget.
1524     * @return mirrored mode setting of the object.
1525     *
1526     **/
1527    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1528
1529    /**
1530     * Sets the widget's mirrored mode setting.
1531     * When widget in automatic mode, it follows the system mirrored mode set by
1532     * elm_mirrored_set().
1533     * @param obj The widget.
1534     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1535     */
1536    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1537
1538    /**
1539     * @}
1540     */
1541
1542    /**
1543     * Set the style to use by a widget
1544     *
1545     * Sets the style name that will define the appearance of a widget. Styles
1546     * vary from widget to widget and may also be defined by other themes
1547     * by means of extensions and overlays.
1548     *
1549     * @param obj The Elementary widget to style
1550     * @param style The style name to use
1551     *
1552     * @see elm_theme_extension_add()
1553     * @see elm_theme_extension_del()
1554     * @see elm_theme_overlay_add()
1555     * @see elm_theme_overlay_del()
1556     *
1557     * @ingroup Styles
1558     */
1559    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1560    /**
1561     * Get the style used by the widget
1562     *
1563     * This gets the style being used for that widget. Note that the string
1564     * pointer is only valid as longas the object is valid and the style doesn't
1565     * change.
1566     *
1567     * @param obj The Elementary widget to query for its style
1568     * @return The style name used
1569     *
1570     * @see elm_object_style_set()
1571     *
1572     * @ingroup Styles
1573     */
1574    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1575
1576    /**
1577     * @defgroup Styles Styles
1578     *
1579     * Widgets can have different styles of look. These generic API's
1580     * set styles of widgets, if they support them (and if the theme(s)
1581     * do).
1582     *
1583     * @ref general_functions_example_page "This" example contemplates
1584     * some of these functions.
1585     */
1586
1587    /**
1588     * Set the disabled state of an Elementary object.
1589     *
1590     * @param obj The Elementary object to operate on
1591     * @param disabled The state to put in in: @c EINA_TRUE for
1592     *        disabled, @c EINA_FALSE for enabled
1593     *
1594     * Elementary objects can be @b disabled, in which state they won't
1595     * receive input and, in general, will be themed differently from
1596     * their normal state, usually greyed out. Useful for contexts
1597     * where you don't want your users to interact with some of the
1598     * parts of you interface.
1599     *
1600     * This sets the state for the widget, either disabling it or
1601     * enabling it back.
1602     *
1603     * @ingroup Styles
1604     */
1605    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1606
1607    /**
1608     * Get the disabled state of an Elementary object.
1609     *
1610     * @param obj The Elementary object to operate on
1611     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1612     *            if it's enabled (or on errors)
1613     *
1614     * This gets the state of the widget, which might be enabled or disabled.
1615     *
1616     * @ingroup Styles
1617     */
1618    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1619
1620    /**
1621     * @defgroup WidgetNavigation Widget Tree Navigation.
1622     *
1623     * How to check if an Evas Object is an Elementary widget? How to
1624     * get the first elementary widget that is parent of the given
1625     * object?  These are all covered in widget tree navigation.
1626     *
1627     * @ref general_functions_example_page "This" example contemplates
1628     * some of these functions.
1629     */
1630
1631    /**
1632     * Check if the given Evas Object is an Elementary widget.
1633     *
1634     * @param obj the object to query.
1635     * @return @c EINA_TRUE if it is an elementary widget variant,
1636     *         @c EINA_FALSE otherwise
1637     * @ingroup WidgetNavigation
1638     */
1639    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1640
1641    /**
1642     * Get the first parent of the given object that is an Elementary
1643     * widget.
1644     *
1645     * @param obj the Elementary object to query parent from.
1646     * @return the parent object that is an Elementary widget, or @c
1647     *         NULL, if it was not found.
1648     *
1649     * Use this to query for an object's parent widget.
1650     *
1651     * @note Most of Elementary users wouldn't be mixing non-Elementary
1652     * smart objects in the objects tree of an application, as this is
1653     * an advanced usage of Elementary with Evas. So, except for the
1654     * application's window, which is the root of that tree, all other
1655     * objects would have valid Elementary widget parents.
1656     *
1657     * @ingroup WidgetNavigation
1658     */
1659    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1660
1661    /**
1662     * Get the top level parent of an Elementary widget.
1663     *
1664     * @param obj The object to query.
1665     * @return The top level Elementary widget, or @c NULL if parent cannot be
1666     * found.
1667     * @ingroup WidgetNavigation
1668     */
1669    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1670
1671    /**
1672     * Get the string that represents this Elementary widget.
1673     *
1674     * @note Elementary is weird and exposes itself as a single
1675     *       Evas_Object_Smart_Class of type "elm_widget", so
1676     *       evas_object_type_get() always return that, making debug and
1677     *       language bindings hard. This function tries to mitigate this
1678     *       problem, but the solution is to change Elementary to use
1679     *       proper inheritance.
1680     *
1681     * @param obj the object to query.
1682     * @return Elementary widget name, or @c NULL if not a valid widget.
1683     * @ingroup WidgetNavigation
1684     */
1685    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1686
1687    /**
1688     * @defgroup Config Elementary Config
1689     *
1690     * Elementary configuration is formed by a set options bounded to a
1691     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1692     * "finger size", etc. These are functions with which one syncronizes
1693     * changes made to those values to the configuration storing files, de
1694     * facto. You most probably don't want to use the functions in this
1695     * group unlees you're writing an elementary configuration manager.
1696     *
1697     * @{
1698     */
1699    EAPI double       elm_scale_get(void);
1700    EAPI void         elm_scale_set(double scale);
1701    EAPI void         elm_scale_all_set(double scale);
1702
1703    /**
1704     * Save back Elementary's configuration, so that it will persist on
1705     * future sessions.
1706     *
1707     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1708     * @ingroup Config
1709     *
1710     * This function will take effect -- thus, do I/O -- immediately. Use
1711     * it when you want to apply all configuration changes at once. The
1712     * current configuration set will get saved onto the current profile
1713     * configuration file.
1714     *
1715     */
1716    EAPI Eina_Bool    elm_mirrored_get(void);
1717    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1718
1719    /**
1720     * Reload Elementary's configuration, bounded to current selected
1721     * profile.
1722     *
1723     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1724     * @ingroup Config
1725     *
1726     * Useful when you want to force reloading of configuration values for
1727     * a profile. If one removes user custom configuration directories,
1728     * for example, it will force a reload with system values insted.
1729     *
1730     */
1731    EAPI Eina_Bool    elm_config_save(void);
1732    EAPI void         elm_config_reload(void);
1733
1734    /**
1735     * @}
1736     */
1737
1738    /**
1739     * @defgroup Profile Elementary Profile
1740     *
1741     * Profiles are pre-set options that affect the whole look-and-feel of
1742     * Elementary-based applications. There are, for example, profiles
1743     * aimed at desktop computer applications and others aimed at mobile,
1744     * touchscreen-based ones. You most probably don't want to use the
1745     * functions in this group unlees you're writing an elementary
1746     * configuration manager.
1747     *
1748     * @{
1749     */
1750
1751    /**
1752     * Get Elementary's profile in use.
1753     *
1754     * This gets the global profile that is applied to all Elementary
1755     * applications.
1756     *
1757     * @return The profile's name
1758     * @ingroup Profile
1759     */
1760    EAPI const char  *elm_profile_current_get(void);
1761
1762    /**
1763     * Get an Elementary's profile directory path in the filesystem. One
1764     * may want to fetch a system profile's dir or an user one (fetched
1765     * inside $HOME).
1766     *
1767     * @param profile The profile's name
1768     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1769     *                or a system one (@c EINA_FALSE)
1770     * @return The profile's directory path.
1771     * @ingroup Profile
1772     *
1773     * @note You must free it with elm_profile_dir_free().
1774     */
1775    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1776
1777    /**
1778     * Free an Elementary's profile directory path, as returned by
1779     * elm_profile_dir_get().
1780     *
1781     * @param p_dir The profile's path
1782     * @ingroup Profile
1783     *
1784     */
1785    EAPI void         elm_profile_dir_free(const char *p_dir);
1786
1787    /**
1788     * Get Elementary's list of available profiles.
1789     *
1790     * @return The profiles list. List node data are the profile name
1791     *         strings.
1792     * @ingroup Profile
1793     *
1794     * @note One must free this list, after usage, with the function
1795     *       elm_profile_list_free().
1796     */
1797    EAPI Eina_List   *elm_profile_list_get(void);
1798
1799    /**
1800     * Free Elementary's list of available profiles.
1801     *
1802     * @param l The profiles list, as returned by elm_profile_list_get().
1803     * @ingroup Profile
1804     *
1805     */
1806    EAPI void         elm_profile_list_free(Eina_List *l);
1807
1808    /**
1809     * Set Elementary's profile.
1810     *
1811     * This sets the global profile that is applied to Elementary
1812     * applications. Just the process the call comes from will be
1813     * affected.
1814     *
1815     * @param profile The profile's name
1816     * @ingroup Profile
1817     *
1818     */
1819    EAPI void         elm_profile_set(const char *profile);
1820
1821    /**
1822     * Set Elementary's profile.
1823     *
1824     * This sets the global profile that is applied to all Elementary
1825     * applications. All running Elementary windows will be affected.
1826     *
1827     * @param profile The profile's name
1828     * @ingroup Profile
1829     *
1830     */
1831    EAPI void         elm_profile_all_set(const char *profile);
1832
1833    /**
1834     * @}
1835     */
1836
1837    /**
1838     * @defgroup Engine Elementary Engine
1839     *
1840     * These are functions setting and querying which rendering engine
1841     * Elementary will use for drawing its windows' pixels.
1842     *
1843     * The following are the available engines:
1844     * @li "software_x11"
1845     * @li "fb"
1846     * @li "directfb"
1847     * @li "software_16_x11"
1848     * @li "software_8_x11"
1849     * @li "xrender_x11"
1850     * @li "opengl_x11"
1851     * @li "software_gdi"
1852     * @li "software_16_wince_gdi"
1853     * @li "sdl"
1854     * @li "software_16_sdl"
1855     * @li "opengl_sdl"
1856     * @li "buffer"
1857     * @li "ews"
1858     *
1859     * @{
1860     */
1861
1862    /**
1863     * @brief Get Elementary's rendering engine in use.
1864     *
1865     * @return The rendering engine's name
1866     * @note there's no need to free the returned string, here.
1867     *
1868     * This gets the global rendering engine that is applied to all Elementary
1869     * applications.
1870     *
1871     * @see elm_engine_set()
1872     */
1873    EAPI const char  *elm_engine_current_get(void);
1874
1875    /**
1876     * @brief Set Elementary's rendering engine for use.
1877     *
1878     * @param engine The rendering engine's name
1879     *
1880     * This sets global rendering engine that is applied to all Elementary
1881     * applications. Note that it will take effect only to Elementary windows
1882     * created after this is called.
1883     *
1884     * @see elm_win_add()
1885     */
1886    EAPI void         elm_engine_set(const char *engine);
1887
1888    /**
1889     * @}
1890     */
1891
1892    /**
1893     * @defgroup Fonts Elementary Fonts
1894     *
1895     * These are functions dealing with font rendering, selection and the
1896     * like for Elementary applications. One might fetch which system
1897     * fonts are there to use and set custom fonts for individual classes
1898     * of UI items containing text (text classes).
1899     *
1900     * @{
1901     */
1902
1903   typedef struct _Elm_Text_Class
1904     {
1905        const char *name;
1906        const char *desc;
1907     } Elm_Text_Class;
1908
1909   typedef struct _Elm_Font_Overlay
1910     {
1911        const char     *text_class;
1912        const char     *font;
1913        Evas_Font_Size  size;
1914     } Elm_Font_Overlay;
1915
1916   typedef struct _Elm_Font_Properties
1917     {
1918        const char *name;
1919        Eina_List  *styles;
1920     } Elm_Font_Properties;
1921
1922    /**
1923     * Get Elementary's list of supported text classes.
1924     *
1925     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1926     * @ingroup Fonts
1927     *
1928     * Release the list with elm_text_classes_list_free().
1929     */
1930    EAPI const Eina_List     *elm_text_classes_list_get(void);
1931
1932    /**
1933     * Free Elementary's list of supported text classes.
1934     *
1935     * @ingroup Fonts
1936     *
1937     * @see elm_text_classes_list_get().
1938     */
1939    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1940
1941    /**
1942     * Get Elementary's list of font overlays, set with
1943     * elm_font_overlay_set().
1944     *
1945     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1946     * data.
1947     *
1948     * @ingroup Fonts
1949     *
1950     * For each text class, one can set a <b>font overlay</b> for it,
1951     * overriding the default font properties for that class coming from
1952     * the theme in use. There is no need to free this list.
1953     *
1954     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1955     */
1956    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1957
1958    /**
1959     * Set a font overlay for a given Elementary text class.
1960     *
1961     * @param text_class Text class name
1962     * @param font Font name and style string
1963     * @param size Font size
1964     *
1965     * @ingroup Fonts
1966     *
1967     * @p font has to be in the format returned by
1968     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1969     * and elm_font_overlay_unset().
1970     */
1971    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1972
1973    /**
1974     * Unset a font overlay for a given Elementary text class.
1975     *
1976     * @param text_class Text class name
1977     *
1978     * @ingroup Fonts
1979     *
1980     * This will bring back text elements belonging to text class
1981     * @p text_class back to their default font settings.
1982     */
1983    EAPI void                 elm_font_overlay_unset(const char *text_class);
1984
1985    /**
1986     * Apply the changes made with elm_font_overlay_set() and
1987     * elm_font_overlay_unset() on the current Elementary window.
1988     *
1989     * @ingroup Fonts
1990     *
1991     * This applies all font overlays set to all objects in the UI.
1992     */
1993    EAPI void                 elm_font_overlay_apply(void);
1994
1995    /**
1996     * Apply the changes made with elm_font_overlay_set() and
1997     * elm_font_overlay_unset() on all Elementary application windows.
1998     *
1999     * @ingroup Fonts
2000     *
2001     * This applies all font overlays set to all objects in the UI.
2002     */
2003    EAPI void                 elm_font_overlay_all_apply(void);
2004
2005    /**
2006     * Translate a font (family) name string in fontconfig's font names
2007     * syntax into an @c Elm_Font_Properties struct.
2008     *
2009     * @param font The font name and styles string
2010     * @return the font properties struct
2011     *
2012     * @ingroup Fonts
2013     *
2014     * @note The reverse translation can be achived with
2015     * elm_font_fontconfig_name_get(), for one style only (single font
2016     * instance, not family).
2017     */
2018    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2019
2020    /**
2021     * Free font properties return by elm_font_properties_get().
2022     *
2023     * @param efp the font properties struct
2024     *
2025     * @ingroup Fonts
2026     */
2027    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2028
2029    /**
2030     * Translate a font name, bound to a style, into fontconfig's font names
2031     * syntax.
2032     *
2033     * @param name The font (family) name
2034     * @param style The given style (may be @c NULL)
2035     *
2036     * @return the font name and style string
2037     *
2038     * @ingroup Fonts
2039     *
2040     * @note The reverse translation can be achived with
2041     * elm_font_properties_get(), for one style only (single font
2042     * instance, not family).
2043     */
2044    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2045
2046    /**
2047     * Free the font string return by elm_font_fontconfig_name_get().
2048     *
2049     * @param efp the font properties struct
2050     *
2051     * @ingroup Fonts
2052     */
2053    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2054
2055    /**
2056     * Create a font hash table of available system fonts.
2057     *
2058     * One must call it with @p list being the return value of
2059     * evas_font_available_list(). The hash will be indexed by font
2060     * (family) names, being its values @c Elm_Font_Properties blobs.
2061     *
2062     * @param list The list of available system fonts, as returned by
2063     * evas_font_available_list().
2064     * @return the font hash.
2065     *
2066     * @ingroup Fonts
2067     *
2068     * @note The user is supposed to get it populated at least with 3
2069     * default font families (Sans, Serif, Monospace), which should be
2070     * present on most systems.
2071     */
2072    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2073
2074    /**
2075     * Free the hash return by elm_font_available_hash_add().
2076     *
2077     * @param hash the hash to be freed.
2078     *
2079     * @ingroup Fonts
2080     */
2081    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2082
2083    /**
2084     * @}
2085     */
2086
2087    /**
2088     * @defgroup Fingers Fingers
2089     *
2090     * Elementary is designed to be finger-friendly for touchscreens,
2091     * and so in addition to scaling for display resolution, it can
2092     * also scale based on finger "resolution" (or size). You can then
2093     * customize the granularity of the areas meant to receive clicks
2094     * on touchscreens.
2095     *
2096     * Different profiles may have pre-set values for finger sizes.
2097     *
2098     * @ref general_functions_example_page "This" example contemplates
2099     * some of these functions.
2100     *
2101     * @{
2102     */
2103
2104    /**
2105     * Get the configured "finger size"
2106     *
2107     * @return The finger size
2108     *
2109     * This gets the globally configured finger size, <b>in pixels</b>
2110     *
2111     * @ingroup Fingers
2112     */
2113    EAPI Evas_Coord       elm_finger_size_get(void);
2114
2115    /**
2116     * Set the configured finger size
2117     *
2118     * This sets the globally configured finger size in pixels
2119     *
2120     * @param size The finger size
2121     * @ingroup Fingers
2122     */
2123    EAPI void             elm_finger_size_set(Evas_Coord size);
2124
2125    /**
2126     * Set the configured finger size for all applications on the display
2127     *
2128     * This sets the globally configured finger size in pixels for all
2129     * applications on the display
2130     *
2131     * @param size The finger size
2132     * @ingroup Fingers
2133     */
2134    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2135
2136    /**
2137     * @}
2138     */
2139
2140    /**
2141     * @defgroup Focus Focus
2142     *
2143     * An Elementary application has, at all times, one (and only one)
2144     * @b focused object. This is what determines where the input
2145     * events go to within the application's window. Also, focused
2146     * objects can be decorated differently, in order to signal to the
2147     * user where the input is, at a given moment.
2148     *
2149     * Elementary applications also have the concept of <b>focus
2150     * chain</b>: one can cycle through all the windows' focusable
2151     * objects by input (tab key) or programmatically. The default
2152     * focus chain for an application is the one define by the order in
2153     * which the widgets where added in code. One will cycle through
2154     * top level widgets, and, for each one containg sub-objects, cycle
2155     * through them all, before returning to the level
2156     * above. Elementary also allows one to set @b custom focus chains
2157     * for their applications.
2158     *
2159     * Besides the focused decoration a widget may exhibit, when it
2160     * gets focus, Elementary has a @b global focus highlight object
2161     * that can be enabled for a window. If one chooses to do so, this
2162     * extra highlight effect will surround the current focused object,
2163     * too.
2164     *
2165     * @note Some Elementary widgets are @b unfocusable, after
2166     * creation, by their very nature: they are not meant to be
2167     * interacted with input events, but are there just for visual
2168     * purposes.
2169     *
2170     * @ref general_functions_example_page "This" example contemplates
2171     * some of these functions.
2172     */
2173
2174    /**
2175     * Get the enable status of the focus highlight
2176     *
2177     * This gets whether the highlight on focused objects is enabled or not
2178     * @ingroup Focus
2179     */
2180    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2181
2182    /**
2183     * Set the enable status of the focus highlight
2184     *
2185     * Set whether to show or not the highlight on focused objects
2186     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2187     * @ingroup Focus
2188     */
2189    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2190
2191    /**
2192     * Get the enable status of the highlight animation
2193     *
2194     * Get whether the focus highlight, if enabled, will animate its switch from
2195     * one object to the next
2196     * @ingroup Focus
2197     */
2198    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2199
2200    /**
2201     * Set the enable status of the highlight animation
2202     *
2203     * Set whether the focus highlight, if enabled, will animate its switch from
2204     * one object to the next
2205     * @param animate Enable animation if EINA_TRUE, disable otherwise
2206     * @ingroup Focus
2207     */
2208    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2209
2210    /**
2211     * Get the whether an Elementary object has the focus or not.
2212     *
2213     * @param obj The Elementary object to get the information from
2214     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2215     *            not (and on errors).
2216     *
2217     * @see elm_object_focus_set()
2218     *
2219     * @ingroup Focus
2220     */
2221    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2222
2223    /**
2224     * Make a given Elementary object the focused one.
2225     *
2226     * @param obj The Elementary object to make focused.
2227     *
2228     * @note This object, if it can handle focus, will take the focus
2229     * away from the one who had it previously and will, for now on, be
2230     * the one receiving input events.
2231     *
2232     * @see elm_object_focus_get()
2233     *
2234     * @ingroup Focus
2235     */
2236    EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2237
2238    /**
2239     * Remove the focus from an Elementary object
2240     *
2241     * @param obj The Elementary to take focus from
2242     *
2243     * This removes the focus from @p obj, passing it back to the
2244     * previous element in the focus chain list.
2245     *
2246     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2247     *
2248     * @ingroup Focus
2249     */
2250    EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2251
2252    /**
2253     * Set the ability for an Element object to be focused
2254     *
2255     * @param obj The Elementary object to operate on
2256     * @param enable @c EINA_TRUE if the object can be focused, @c
2257     *        EINA_FALSE if not (and on errors)
2258     *
2259     * This sets whether the object @p obj is able to take focus or
2260     * not. Unfocusable objects do nothing when programmatically
2261     * focused, being the nearest focusable parent object the one
2262     * really getting focus. Also, when they receive mouse input, they
2263     * will get the event, but not take away the focus from where it
2264     * was previously.
2265     *
2266     * @ingroup Focus
2267     */
2268    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2269
2270    /**
2271     * Get whether an Elementary object is focusable or not
2272     *
2273     * @param obj The Elementary object to operate on
2274     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2275     *             EINA_FALSE if not (and on errors)
2276     *
2277     * @note Objects which are meant to be interacted with by input
2278     * events are created able to be focused, by default. All the
2279     * others are not.
2280     *
2281     * @ingroup Focus
2282     */
2283    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2284
2285    /**
2286     * Set custom focus chain.
2287     *
2288     * This function overwrites any previous custom focus chain within
2289     * the list of objects. The previous list will be deleted and this list
2290     * will be managed by elementary. After it is set, don't modify it.
2291     *
2292     * @note On focus cycle, only will be evaluated children of this container.
2293     *
2294     * @param obj The container object
2295     * @param objs Chain of objects to pass focus
2296     * @ingroup Focus
2297     */
2298    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2299
2300    /**
2301     * Unset a custom focus chain on a given Elementary widget
2302     *
2303     * @param obj The container object to remove focus chain from
2304     *
2305     * Any focus chain previously set on @p obj (for its child objects)
2306     * is removed entirely after this call.
2307     *
2308     * @ingroup Focus
2309     */
2310    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2311
2312    /**
2313     * Get custom focus chain
2314     *
2315     * @param obj The container object
2316     * @ingroup Focus
2317     */
2318    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2319
2320    /**
2321     * Append object to custom focus chain.
2322     *
2323     * @note If relative_child equal to NULL or not in custom chain, the object
2324     * will be added in end.
2325     *
2326     * @note On focus cycle, only will be evaluated children of this container.
2327     *
2328     * @param obj The container object
2329     * @param child The child to be added in custom chain
2330     * @param relative_child The relative object to position the child
2331     * @ingroup Focus
2332     */
2333    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2334
2335    /**
2336     * Prepend object to custom focus chain.
2337     *
2338     * @note If relative_child equal to NULL or not in custom chain, the object
2339     * will be added in begin.
2340     *
2341     * @note On focus cycle, only will be evaluated children of this container.
2342     *
2343     * @param obj The container object
2344     * @param child The child to be added in custom chain
2345     * @param relative_child The relative object to position the child
2346     * @ingroup Focus
2347     */
2348    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2349
2350    /**
2351     * Give focus to next object in object tree.
2352     *
2353     * Give focus to next object in focus chain of one object sub-tree.
2354     * If the last object of chain already have focus, the focus will go to the
2355     * first object of chain.
2356     *
2357     * @param obj The object root of sub-tree
2358     * @param dir Direction to cycle the focus
2359     *
2360     * @ingroup Focus
2361     */
2362    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2363
2364    /**
2365     * Give focus to near object in one direction.
2366     *
2367     * Give focus to near object in direction of one object.
2368     * If none focusable object in given direction, the focus will not change.
2369     *
2370     * @param obj The reference object
2371     * @param x Horizontal component of direction to focus
2372     * @param y Vertical component of direction to focus
2373     *
2374     * @ingroup Focus
2375     */
2376    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2377
2378    /**
2379     * Make the elementary object and its children to be unfocusable
2380     * (or focusable).
2381     *
2382     * @param obj The Elementary object to operate on
2383     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2384     *        @c EINA_FALSE for focusable.
2385     *
2386     * This sets whether the object @p obj and its children objects
2387     * are able to take focus or not. If the tree is set as unfocusable,
2388     * newest focused object which is not in this tree will get focus.
2389     * This API can be helpful for an object to be deleted.
2390     * When an object will be deleted soon, it and its children may not
2391     * want to get focus (by focus reverting or by other focus controls).
2392     * Then, just use this API before deleting.
2393     *
2394     * @see elm_object_tree_unfocusable_get()
2395     *
2396     * @ingroup Focus
2397     */
2398    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2399
2400    /**
2401     * Get whether an Elementary object and its children are unfocusable or not.
2402     *
2403     * @param obj The Elementary object to get the information from
2404     * @return @c EINA_TRUE, if the tree is unfocussable,
2405     *         @c EINA_FALSE if not (and on errors).
2406     *
2407     * @see elm_object_tree_unfocusable_set()
2408     *
2409     * @ingroup Focus
2410     */
2411    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2412
2413    /**
2414     * @defgroup Scrolling Scrolling
2415     *
2416     * These are functions setting how scrollable views in Elementary
2417     * widgets should behave on user interaction.
2418     *
2419     * @{
2420     */
2421
2422    /**
2423     * Get whether scrollers should bounce when they reach their
2424     * viewport's edge during a scroll.
2425     *
2426     * @return the thumb scroll bouncing state
2427     *
2428     * This is the default behavior for touch screens, in general.
2429     * @ingroup Scrolling
2430     */
2431    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2432
2433    /**
2434     * Set whether scrollers should bounce when they reach their
2435     * viewport's edge during a scroll.
2436     *
2437     * @param enabled the thumb scroll bouncing state
2438     *
2439     * @see elm_thumbscroll_bounce_enabled_get()
2440     * @ingroup Scrolling
2441     */
2442    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2443
2444    /**
2445     * Set whether scrollers should bounce when they reach their
2446     * viewport's edge during a scroll, for all Elementary application
2447     * windows.
2448     *
2449     * @param enabled the thumb scroll bouncing state
2450     *
2451     * @see elm_thumbscroll_bounce_enabled_get()
2452     * @ingroup Scrolling
2453     */
2454    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2455
2456    /**
2457     * Get the amount of inertia a scroller will impose at bounce
2458     * animations.
2459     *
2460     * @return the thumb scroll bounce friction
2461     *
2462     * @ingroup Scrolling
2463     */
2464    EAPI double           elm_scroll_bounce_friction_get(void);
2465
2466    /**
2467     * Set the amount of inertia a scroller will impose at bounce
2468     * animations.
2469     *
2470     * @param friction the thumb scroll bounce friction
2471     *
2472     * @see elm_thumbscroll_bounce_friction_get()
2473     * @ingroup Scrolling
2474     */
2475    EAPI void             elm_scroll_bounce_friction_set(double friction);
2476
2477    /**
2478     * Set the amount of inertia a scroller will impose at bounce
2479     * animations, for all Elementary application windows.
2480     *
2481     * @param friction the thumb scroll bounce friction
2482     *
2483     * @see elm_thumbscroll_bounce_friction_get()
2484     * @ingroup Scrolling
2485     */
2486    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2487
2488    /**
2489     * Get the amount of inertia a <b>paged</b> scroller will impose at
2490     * page fitting animations.
2491     *
2492     * @return the page scroll friction
2493     *
2494     * @ingroup Scrolling
2495     */
2496    EAPI double           elm_scroll_page_scroll_friction_get(void);
2497
2498    /**
2499     * Set the amount of inertia a <b>paged</b> scroller will impose at
2500     * page fitting animations.
2501     *
2502     * @param friction the page scroll friction
2503     *
2504     * @see elm_thumbscroll_page_scroll_friction_get()
2505     * @ingroup Scrolling
2506     */
2507    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2508
2509    /**
2510     * Set the amount of inertia a <b>paged</b> scroller will impose at
2511     * page fitting animations, for all Elementary application windows.
2512     *
2513     * @param friction the page scroll friction
2514     *
2515     * @see elm_thumbscroll_page_scroll_friction_get()
2516     * @ingroup Scrolling
2517     */
2518    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2519
2520    /**
2521     * Get the amount of inertia a scroller will impose at region bring
2522     * animations.
2523     *
2524     * @return the bring in scroll friction
2525     *
2526     * @ingroup Scrolling
2527     */
2528    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2529
2530    /**
2531     * Set the amount of inertia a scroller will impose at region bring
2532     * animations.
2533     *
2534     * @param friction the bring in scroll friction
2535     *
2536     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2537     * @ingroup Scrolling
2538     */
2539    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2540
2541    /**
2542     * Set the amount of inertia a scroller will impose at region bring
2543     * animations, for all Elementary application windows.
2544     *
2545     * @param friction the bring in scroll friction
2546     *
2547     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2548     * @ingroup Scrolling
2549     */
2550    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2551
2552    /**
2553     * Get the amount of inertia scrollers will impose at animations
2554     * triggered by Elementary widgets' zooming API.
2555     *
2556     * @return the zoom friction
2557     *
2558     * @ingroup Scrolling
2559     */
2560    EAPI double           elm_scroll_zoom_friction_get(void);
2561
2562    /**
2563     * Set the amount of inertia scrollers will impose at animations
2564     * triggered by Elementary widgets' zooming API.
2565     *
2566     * @param friction the zoom friction
2567     *
2568     * @see elm_thumbscroll_zoom_friction_get()
2569     * @ingroup Scrolling
2570     */
2571    EAPI void             elm_scroll_zoom_friction_set(double friction);
2572
2573    /**
2574     * Set the amount of inertia scrollers will impose at animations
2575     * triggered by Elementary widgets' zooming API, for all Elementary
2576     * application windows.
2577     *
2578     * @param friction the zoom friction
2579     *
2580     * @see elm_thumbscroll_zoom_friction_get()
2581     * @ingroup Scrolling
2582     */
2583    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2584
2585    /**
2586     * Get whether scrollers should be draggable from any point in their
2587     * views.
2588     *
2589     * @return the thumb scroll state
2590     *
2591     * @note This is the default behavior for touch screens, in general.
2592     * @note All other functions namespaced with "thumbscroll" will only
2593     *       have effect if this mode is enabled.
2594     *
2595     * @ingroup Scrolling
2596     */
2597    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2598
2599    /**
2600     * Set whether scrollers should be draggable from any point in their
2601     * views.
2602     *
2603     * @param enabled the thumb scroll state
2604     *
2605     * @see elm_thumbscroll_enabled_get()
2606     * @ingroup Scrolling
2607     */
2608    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2609
2610    /**
2611     * Set whether scrollers should be draggable from any point in their
2612     * views, for all Elementary application windows.
2613     *
2614     * @param enabled the thumb scroll state
2615     *
2616     * @see elm_thumbscroll_enabled_get()
2617     * @ingroup Scrolling
2618     */
2619    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2620
2621    /**
2622     * Get the number of pixels one should travel while dragging a
2623     * scroller's view to actually trigger scrolling.
2624     *
2625     * @return the thumb scroll threshould
2626     *
2627     * One would use higher values for touch screens, in general, because
2628     * of their inherent imprecision.
2629     * @ingroup Scrolling
2630     */
2631    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2632
2633    /**
2634     * Set the number of pixels one should travel while dragging a
2635     * scroller's view to actually trigger scrolling.
2636     *
2637     * @param threshold the thumb scroll threshould
2638     *
2639     * @see elm_thumbscroll_threshould_get()
2640     * @ingroup Scrolling
2641     */
2642    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2643
2644    /**
2645     * Set the number of pixels one should travel while dragging a
2646     * scroller's view to actually trigger scrolling, for all Elementary
2647     * application windows.
2648     *
2649     * @param threshold the thumb scroll threshould
2650     *
2651     * @see elm_thumbscroll_threshould_get()
2652     * @ingroup Scrolling
2653     */
2654    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2655
2656    /**
2657     * Get the minimum speed of mouse cursor movement which will trigger
2658     * list self scrolling animation after a mouse up event
2659     * (pixels/second).
2660     *
2661     * @return the thumb scroll momentum threshould
2662     *
2663     * @ingroup Scrolling
2664     */
2665    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2666
2667    /**
2668     * Set the minimum speed of mouse cursor movement which will trigger
2669     * list self scrolling animation after a mouse up event
2670     * (pixels/second).
2671     *
2672     * @param threshold the thumb scroll momentum threshould
2673     *
2674     * @see elm_thumbscroll_momentum_threshould_get()
2675     * @ingroup Scrolling
2676     */
2677    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2678
2679    /**
2680     * Set the minimum speed of mouse cursor movement which will trigger
2681     * list self scrolling animation after a mouse up event
2682     * (pixels/second), for all Elementary application windows.
2683     *
2684     * @param threshold the thumb scroll momentum threshould
2685     *
2686     * @see elm_thumbscroll_momentum_threshould_get()
2687     * @ingroup Scrolling
2688     */
2689    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2690
2691    /**
2692     * Get the amount of inertia a scroller will impose at self scrolling
2693     * animations.
2694     *
2695     * @return the thumb scroll friction
2696     *
2697     * @ingroup Scrolling
2698     */
2699    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2700
2701    /**
2702     * Set the amount of inertia a scroller will impose at self scrolling
2703     * animations.
2704     *
2705     * @param friction the thumb scroll friction
2706     *
2707     * @see elm_thumbscroll_friction_get()
2708     * @ingroup Scrolling
2709     */
2710    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2711
2712    /**
2713     * Set the amount of inertia a scroller will impose at self scrolling
2714     * animations, for all Elementary application windows.
2715     *
2716     * @param friction the thumb scroll friction
2717     *
2718     * @see elm_thumbscroll_friction_get()
2719     * @ingroup Scrolling
2720     */
2721    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2722
2723    /**
2724     * Get the amount of lag between your actual mouse cursor dragging
2725     * movement and a scroller's view movement itself, while pushing it
2726     * into bounce state manually.
2727     *
2728     * @return the thumb scroll border friction
2729     *
2730     * @ingroup Scrolling
2731     */
2732    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2733
2734    /**
2735     * Set the amount of lag between your actual mouse cursor dragging
2736     * movement and a scroller's view movement itself, while pushing it
2737     * into bounce state manually.
2738     *
2739     * @param friction the thumb scroll border friction. @c 0.0 for
2740     *        perfect synchrony between two movements, @c 1.0 for maximum
2741     *        lag.
2742     *
2743     * @see elm_thumbscroll_border_friction_get()
2744     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2745     *
2746     * @ingroup Scrolling
2747     */
2748    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2749
2750    /**
2751     * Set the amount of lag between your actual mouse cursor dragging
2752     * movement and a scroller's view movement itself, while pushing it
2753     * into bounce state manually, for all Elementary application windows.
2754     *
2755     * @param friction the thumb scroll border friction. @c 0.0 for
2756     *        perfect synchrony between two movements, @c 1.0 for maximum
2757     *        lag.
2758     *
2759     * @see elm_thumbscroll_border_friction_get()
2760     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2761     *
2762     * @ingroup Scrolling
2763     */
2764    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2765
2766    /**
2767     * Get the sensitivity amount which is be multiplied by the length of
2768     * mouse dragging.
2769     *
2770     * @return the thumb scroll sensitivity friction
2771     *
2772     * @ingroup Scrolling
2773     */
2774    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
2775
2776    /**
2777     * Set the sensitivity amount which is be multiplied by the length of
2778     * mouse dragging.
2779     *
2780     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2781     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2782     *        is proper.
2783     *
2784     * @see elm_thumbscroll_sensitivity_friction_get()
2785     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2786     *
2787     * @ingroup Scrolling
2788     */
2789    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2790
2791    /**
2792     * Set the sensitivity amount which is be multiplied by the length of
2793     * mouse dragging, for all Elementary application windows.
2794     *
2795     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2796     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2797     *        is proper.
2798     *
2799     * @see elm_thumbscroll_sensitivity_friction_get()
2800     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2801     *
2802     * @ingroup Scrolling
2803     */
2804    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2805
2806    /**
2807     * @}
2808     */
2809
2810    /**
2811     * @defgroup Scrollhints Scrollhints
2812     *
2813     * Objects when inside a scroller can scroll, but this may not always be
2814     * desirable in certain situations. This allows an object to hint to itself
2815     * and parents to "not scroll" in one of 2 ways. If any child object of a
2816     * scroller has pushed a scroll freeze or hold then it affects all parent
2817     * scrollers until all children have released them.
2818     *
2819     * 1. To hold on scrolling. This means just flicking and dragging may no
2820     * longer scroll, but pressing/dragging near an edge of the scroller will
2821     * still scroll. This is automatically used by the entry object when
2822     * selecting text.
2823     *
2824     * 2. To totally freeze scrolling. This means it stops. until
2825     * popped/released.
2826     *
2827     * @{
2828     */
2829
2830    /**
2831     * Push the scroll hold by 1
2832     *
2833     * This increments the scroll hold count by one. If it is more than 0 it will
2834     * take effect on the parents of the indicated object.
2835     *
2836     * @param obj The object
2837     * @ingroup Scrollhints
2838     */
2839    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2840
2841    /**
2842     * Pop the scroll hold by 1
2843     *
2844     * This decrements the scroll hold count by one. If it is more than 0 it will
2845     * take effect on the parents of the indicated object.
2846     *
2847     * @param obj The object
2848     * @ingroup Scrollhints
2849     */
2850    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2851
2852    /**
2853     * Push the scroll freeze by 1
2854     *
2855     * This increments the scroll freeze count by one. If it is more
2856     * than 0 it will take effect on the parents of the indicated
2857     * object.
2858     *
2859     * @param obj The object
2860     * @ingroup Scrollhints
2861     */
2862    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2863
2864    /**
2865     * Pop the scroll freeze by 1
2866     *
2867     * This decrements the scroll freeze count by one. If it is more
2868     * than 0 it will take effect on the parents of the indicated
2869     * object.
2870     *
2871     * @param obj The object
2872     * @ingroup Scrollhints
2873     */
2874    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2875
2876    /**
2877     * Lock the scrolling of the given widget (and thus all parents)
2878     *
2879     * This locks the given object from scrolling in the X axis (and implicitly
2880     * also locks all parent scrollers too from doing the same).
2881     *
2882     * @param obj The object
2883     * @param lock The lock state (1 == locked, 0 == unlocked)
2884     * @ingroup Scrollhints
2885     */
2886    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2887
2888    /**
2889     * Lock the scrolling of the given widget (and thus all parents)
2890     *
2891     * This locks the given object from scrolling in the Y axis (and implicitly
2892     * also locks all parent scrollers too from doing the same).
2893     *
2894     * @param obj The object
2895     * @param lock The lock state (1 == locked, 0 == unlocked)
2896     * @ingroup Scrollhints
2897     */
2898    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2899
2900    /**
2901     * Get the scrolling lock of the given widget
2902     *
2903     * This gets the lock for X axis scrolling.
2904     *
2905     * @param obj The object
2906     * @ingroup Scrollhints
2907     */
2908    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2909
2910    /**
2911     * Get the scrolling lock of the given widget
2912     *
2913     * This gets the lock for X axis scrolling.
2914     *
2915     * @param obj The object
2916     * @ingroup Scrollhints
2917     */
2918    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2919
2920    /**
2921     * @}
2922     */
2923
2924    /**
2925     * Send a signal to the widget edje object.
2926     *
2927     * This function sends a signal to the edje object of the obj. An
2928     * edje program can respond to a signal by specifying matching
2929     * 'signal' and 'source' fields.
2930     *
2931     * @param obj The object
2932     * @param emission The signal's name.
2933     * @param source The signal's source.
2934     * @ingroup General
2935     */
2936    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2937    EAPI void             elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data) EINA_ARG_NONNULL(1, 4);
2938    EAPI void            *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source)) EINA_ARG_NONNULL(1, 4);
2939
2940    /**
2941     * Add a callback for a signal emitted by widget edje object.
2942     *
2943     * This function connects a callback function to a signal emitted by the
2944     * edje object of the obj.
2945     * Globs can occur in either the emission or source name.
2946     *
2947     * @param obj The object
2948     * @param emission The signal's name.
2949     * @param source The signal's source.
2950     * @param func The callback function to be executed when the signal is
2951     * emitted.
2952     * @param data A pointer to data to pass in to the callback function.
2953     * @ingroup General
2954     */
2955    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);
2956
2957    /**
2958     * Remove a signal-triggered callback from a widget edje object.
2959     *
2960     * This function removes a callback, previoulsy attached to a
2961     * signal emitted by the edje object of the obj.  The parameters
2962     * emission, source and func must match exactly those passed to a
2963     * previous call to elm_object_signal_callback_add(). The data
2964     * pointer that was passed to this call will be returned.
2965     *
2966     * @param obj The object
2967     * @param emission The signal's name.
2968     * @param source The signal's source.
2969     * @param func The callback function to be executed when the signal is
2970     * emitted.
2971     * @return The data pointer
2972     * @ingroup General
2973     */
2974    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);
2975
2976    /**
2977     * Add a callback for input events (key up, key down, mouse wheel)
2978     * on a given Elementary widget
2979     *
2980     * @param obj The widget to add an event callback on
2981     * @param func The callback function to be executed when the event
2982     * happens
2983     * @param data Data to pass in to @p func
2984     *
2985     * Every widget in an Elementary interface set to receive focus,
2986     * with elm_object_focus_allow_set(), will propagate @b all of its
2987     * key up, key down and mouse wheel input events up to its parent
2988     * object, and so on. All of the focusable ones in this chain which
2989     * had an event callback set, with this call, will be able to treat
2990     * those events. There are two ways of making the propagation of
2991     * these event upwards in the tree of widgets to @b cease:
2992     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2993     *   the event was @b not processed, so the propagation will go on.
2994     * - The @c event_info pointer passed to @p func will contain the
2995     *   event's structure and, if you OR its @c event_flags inner
2996     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2997     *   one has already handled it, thus killing the event's
2998     *   propagation, too.
2999     *
3000     * @note Your event callback will be issued on those events taking
3001     * place only if no other child widget of @obj has consumed the
3002     * event already.
3003     *
3004     * @note Not to be confused with @c
3005     * evas_object_event_callback_add(), which will add event callbacks
3006     * per type on general Evas objects (no event propagation
3007     * infrastructure taken in account).
3008     *
3009     * @note Not to be confused with @c
3010     * elm_object_signal_callback_add(), which will add callbacks to @b
3011     * signals coming from a widget's theme, not input events.
3012     *
3013     * @note Not to be confused with @c
3014     * edje_object_signal_callback_add(), which does the same as
3015     * elm_object_signal_callback_add(), but directly on an Edje
3016     * object.
3017     *
3018     * @note Not to be confused with @c
3019     * evas_object_smart_callback_add(), which adds callbacks to smart
3020     * objects' <b>smart events</b>, and not input events.
3021     *
3022     * @see elm_object_event_callback_del()
3023     *
3024     * @ingroup General
3025     */
3026    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3027
3028    /**
3029     * Remove an event callback from a widget.
3030     *
3031     * This function removes a callback, previoulsy attached to event emission
3032     * by the @p obj.
3033     * The parameters func and data must match exactly those passed to
3034     * a previous call to elm_object_event_callback_add(). The data pointer that
3035     * was passed to this call will be returned.
3036     *
3037     * @param obj The object
3038     * @param func The callback function to be executed when the event is
3039     * emitted.
3040     * @param data Data to pass in to the callback function.
3041     * @return The data pointer
3042     * @ingroup General
3043     */
3044    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3045
3046    /**
3047     * Adjust size of an element for finger usage.
3048     *
3049     * @param times_w How many fingers should fit horizontally
3050     * @param w Pointer to the width size to adjust
3051     * @param times_h How many fingers should fit vertically
3052     * @param h Pointer to the height size to adjust
3053     *
3054     * This takes width and height sizes (in pixels) as input and a
3055     * size multiple (which is how many fingers you want to place
3056     * within the area, being "finger" the size set by
3057     * elm_finger_size_set()), and adjusts the size to be large enough
3058     * to accommodate the resulting size -- if it doesn't already
3059     * accommodate it. On return the @p w and @p h sizes pointed to by
3060     * these parameters will be modified, on those conditions.
3061     *
3062     * @note This is kind of a low level Elementary call, most useful
3063     * on size evaluation times for widgets. An external user wouldn't
3064     * be calling, most of the time.
3065     *
3066     * @ingroup Fingers
3067     */
3068    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3069
3070    /**
3071     * Get the duration for occuring long press event.
3072     *
3073     * @return Timeout for long press event
3074     * @ingroup Longpress
3075     */
3076    EAPI double           elm_longpress_timeout_get(void);
3077
3078    /**
3079     * Set the duration for occuring long press event.
3080     *
3081     * @param lonpress_timeout Timeout for long press event
3082     * @ingroup Longpress
3083     */
3084    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3085
3086    /**
3087     * @defgroup Debug Debug
3088     * don't use it unless you are sure
3089     *
3090     * @{
3091     */
3092
3093    /**
3094     * Print Tree object hierarchy in stdout
3095     *
3096     * @param obj The root object
3097     * @ingroup Debug
3098     */
3099    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3100    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3101
3102    EAPI void             elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3103    EAPI void             elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3104    /**
3105     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3106     *
3107     * @param obj The root object
3108     * @param file The path of output file
3109     * @ingroup Debug
3110     */
3111    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3112
3113    /**
3114     * @}
3115     */
3116
3117    /**
3118     * @defgroup Theme Theme
3119     *
3120     * Elementary uses Edje to theme its widgets, naturally. But for the most
3121     * part this is hidden behind a simpler interface that lets the user set
3122     * extensions and choose the style of widgets in a much easier way.
3123     *
3124     * Instead of thinking in terms of paths to Edje files and their groups
3125     * each time you want to change the appearance of a widget, Elementary
3126     * works so you can add any theme file with extensions or replace the
3127     * main theme at one point in the application, and then just set the style
3128     * of widgets with elm_object_style_set() and related functions. Elementary
3129     * will then look in its list of themes for a matching group and apply it,
3130     * and when the theme changes midway through the application, all widgets
3131     * will be updated accordingly.
3132     *
3133     * There are three concepts you need to know to understand how Elementary
3134     * theming works: default theme, extensions and overlays.
3135     *
3136     * Default theme, obviously enough, is the one that provides the default
3137     * look of all widgets. End users can change the theme used by Elementary
3138     * by setting the @c ELM_THEME environment variable before running an
3139     * application, or globally for all programs using the @c elementary_config
3140     * utility. Applications can change the default theme using elm_theme_set(),
3141     * but this can go against the user wishes, so it's not an adviced practice.
3142     *
3143     * Ideally, applications should find everything they need in the already
3144     * provided theme, but there may be occasions when that's not enough and
3145     * custom styles are required to correctly express the idea. For this
3146     * cases, Elementary has extensions.
3147     *
3148     * Extensions allow the application developer to write styles of its own
3149     * to apply to some widgets. This requires knowledge of how each widget
3150     * is themed, as extensions will always replace the entire group used by
3151     * the widget, so important signals and parts need to be there for the
3152     * object to behave properly (see documentation of Edje for details).
3153     * Once the theme for the extension is done, the application needs to add
3154     * it to the list of themes Elementary will look into, using
3155     * elm_theme_extension_add(), and set the style of the desired widgets as
3156     * he would normally with elm_object_style_set().
3157     *
3158     * Overlays, on the other hand, can replace the look of all widgets by
3159     * overriding the default style. Like extensions, it's up to the application
3160     * developer to write the theme for the widgets it wants, the difference
3161     * being that when looking for the theme, Elementary will check first the
3162     * list of overlays, then the set theme and lastly the list of extensions,
3163     * so with overlays it's possible to replace the default view and every
3164     * widget will be affected. This is very much alike to setting the whole
3165     * theme for the application and will probably clash with the end user
3166     * options, not to mention the risk of ending up with not matching styles
3167     * across the program. Unless there's a very special reason to use them,
3168     * overlays should be avoided for the resons exposed before.
3169     *
3170     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3171     * keeps one default internally and every function that receives one of
3172     * these can be called with NULL to refer to this default (except for
3173     * elm_theme_free()). It's possible to create a new instance of a
3174     * ::Elm_Theme to set other theme for a specific widget (and all of its
3175     * children), but this is as discouraged, if not even more so, than using
3176     * overlays. Don't use this unless you really know what you are doing.
3177     *
3178     * But to be less negative about things, you can look at the following
3179     * examples:
3180     * @li @ref theme_example_01 "Using extensions"
3181     * @li @ref theme_example_02 "Using overlays"
3182     *
3183     * @{
3184     */
3185    /**
3186     * @typedef Elm_Theme
3187     *
3188     * Opaque handler for the list of themes Elementary looks for when
3189     * rendering widgets.
3190     *
3191     * Stay out of this unless you really know what you are doing. For most
3192     * cases, sticking to the default is all a developer needs.
3193     */
3194    typedef struct _Elm_Theme Elm_Theme;
3195
3196    /**
3197     * Create a new specific theme
3198     *
3199     * This creates an empty specific theme that only uses the default theme. A
3200     * specific theme has its own private set of extensions and overlays too
3201     * (which are empty by default). Specific themes do not fall back to themes
3202     * of parent objects. They are not intended for this use. Use styles, overlays
3203     * and extensions when needed, but avoid specific themes unless there is no
3204     * other way (example: you want to have a preview of a new theme you are
3205     * selecting in a "theme selector" window. The preview is inside a scroller
3206     * and should display what the theme you selected will look like, but not
3207     * actually apply it yet. The child of the scroller will have a specific
3208     * theme set to show this preview before the user decides to apply it to all
3209     * applications).
3210     */
3211    EAPI Elm_Theme       *elm_theme_new(void);
3212    /**
3213     * Free a specific theme
3214     *
3215     * @param th The theme to free
3216     *
3217     * This frees a theme created with elm_theme_new().
3218     */
3219    EAPI void             elm_theme_free(Elm_Theme *th);
3220    /**
3221     * Copy the theme fom the source to the destination theme
3222     *
3223     * @param th The source theme to copy from
3224     * @param thdst The destination theme to copy data to
3225     *
3226     * This makes a one-time static copy of all the theme config, extensions
3227     * and overlays from @p th to @p thdst. If @p th references a theme, then
3228     * @p thdst is also set to reference it, with all the theme settings,
3229     * overlays and extensions that @p th had.
3230     */
3231    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3232    /**
3233     * Tell the source theme to reference the ref theme
3234     *
3235     * @param th The theme that will do the referencing
3236     * @param thref The theme that is the reference source
3237     *
3238     * This clears @p th to be empty and then sets it to refer to @p thref
3239     * so @p th acts as an override to @p thref, but where its overrides
3240     * don't apply, it will fall through to @p thref for configuration.
3241     */
3242    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3243    /**
3244     * Return the theme referred to
3245     *
3246     * @param th The theme to get the reference from
3247     * @return The referenced theme handle
3248     *
3249     * This gets the theme set as the reference theme by elm_theme_ref_set().
3250     * If no theme is set as a reference, NULL is returned.
3251     */
3252    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3253    /**
3254     * Return the default theme
3255     *
3256     * @return The default theme handle
3257     *
3258     * This returns the internal default theme setup handle that all widgets
3259     * use implicitly unless a specific theme is set. This is also often use
3260     * as a shorthand of NULL.
3261     */
3262    EAPI Elm_Theme       *elm_theme_default_get(void);
3263    /**
3264     * Prepends a theme overlay to the list of overlays
3265     *
3266     * @param th The theme to add to, or if NULL, the default theme
3267     * @param item The Edje file path to be used
3268     *
3269     * Use this if your application needs to provide some custom overlay theme
3270     * (An Edje file that replaces some default styles of widgets) where adding
3271     * new styles, or changing system theme configuration is not possible. Do
3272     * NOT use this instead of a proper system theme configuration. Use proper
3273     * configuration files, profiles, environment variables etc. to set a theme
3274     * so that the theme can be altered by simple confiugration by a user. Using
3275     * this call to achieve that effect is abusing the API and will create lots
3276     * of trouble.
3277     *
3278     * @see elm_theme_extension_add()
3279     */
3280    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3281    /**
3282     * Delete a theme overlay from the list of overlays
3283     *
3284     * @param th The theme to delete from, or if NULL, the default theme
3285     * @param item The name of the theme overlay
3286     *
3287     * @see elm_theme_overlay_add()
3288     */
3289    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3290    /**
3291     * Appends a theme extension to the list of extensions.
3292     *
3293     * @param th The theme to add to, or if NULL, the default theme
3294     * @param item The Edje file path to be used
3295     *
3296     * This is intended when an application needs more styles of widgets or new
3297     * widget themes that the default does not provide (or may not provide). The
3298     * application has "extended" usage by coming up with new custom style names
3299     * for widgets for specific uses, but as these are not "standard", they are
3300     * not guaranteed to be provided by a default theme. This means the
3301     * application is required to provide these extra elements itself in specific
3302     * Edje files. This call adds one of those Edje files to the theme search
3303     * path to be search after the default theme. The use of this call is
3304     * encouraged when default styles do not meet the needs of the application.
3305     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3306     *
3307     * @see elm_object_style_set()
3308     */
3309    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3310    /**
3311     * Deletes a theme extension from the list of extensions.
3312     *
3313     * @param th The theme to delete from, or if NULL, the default theme
3314     * @param item The name of the theme extension
3315     *
3316     * @see elm_theme_extension_add()
3317     */
3318    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3319    /**
3320     * Set the theme search order for the given theme
3321     *
3322     * @param th The theme to set the search order, or if NULL, the default theme
3323     * @param theme Theme search string
3324     *
3325     * This sets the search string for the theme in path-notation from first
3326     * theme to search, to last, delimited by the : character. Example:
3327     *
3328     * "shiny:/path/to/file.edj:default"
3329     *
3330     * See the ELM_THEME environment variable for more information.
3331     *
3332     * @see elm_theme_get()
3333     * @see elm_theme_list_get()
3334     */
3335    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3336    /**
3337     * Return the theme search order
3338     *
3339     * @param th The theme to get the search order, or if NULL, the default theme
3340     * @return The internal search order path
3341     *
3342     * This function returns a colon separated string of theme elements as
3343     * returned by elm_theme_list_get().
3344     *
3345     * @see elm_theme_set()
3346     * @see elm_theme_list_get()
3347     */
3348    EAPI const char      *elm_theme_get(Elm_Theme *th);
3349    /**
3350     * Return a list of theme elements to be used in a theme.
3351     *
3352     * @param th Theme to get the list of theme elements from.
3353     * @return The internal list of theme elements
3354     *
3355     * This returns the internal list of theme elements (will only be valid as
3356     * long as the theme is not modified by elm_theme_set() or theme is not
3357     * freed by elm_theme_free(). This is a list of strings which must not be
3358     * altered as they are also internal. If @p th is NULL, then the default
3359     * theme element list is returned.
3360     *
3361     * A theme element can consist of a full or relative path to a .edj file,
3362     * or a name, without extension, for a theme to be searched in the known
3363     * theme paths for Elemementary.
3364     *
3365     * @see elm_theme_set()
3366     * @see elm_theme_get()
3367     */
3368    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3369    /**
3370     * Return the full patrh for a theme element
3371     *
3372     * @param f The theme element name
3373     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3374     * @return The full path to the file found.
3375     *
3376     * This returns a string you should free with free() on success, NULL on
3377     * failure. This will search for the given theme element, and if it is a
3378     * full or relative path element or a simple searchable name. The returned
3379     * path is the full path to the file, if searched, and the file exists, or it
3380     * is simply the full path given in the element or a resolved path if
3381     * relative to home. The @p in_search_path boolean pointed to is set to
3382     * EINA_TRUE if the file was a searchable file andis in the search path,
3383     * and EINA_FALSE otherwise.
3384     */
3385    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3386    /**
3387     * Flush the current theme.
3388     *
3389     * @param th Theme to flush
3390     *
3391     * This flushes caches that let elementary know where to find theme elements
3392     * in the given theme. If @p th is NULL, then the default theme is flushed.
3393     * Call this function if source theme data has changed in such a way as to
3394     * make any caches Elementary kept invalid.
3395     */
3396    EAPI void             elm_theme_flush(Elm_Theme *th);
3397    /**
3398     * This flushes all themes (default and specific ones).
3399     *
3400     * This will flush all themes in the current application context, by calling
3401     * elm_theme_flush() on each of them.
3402     */
3403    EAPI void             elm_theme_full_flush(void);
3404    /**
3405     * Set the theme for all elementary using applications on the current display
3406     *
3407     * @param theme The name of the theme to use. Format same as the ELM_THEME
3408     * environment variable.
3409     */
3410    EAPI void             elm_theme_all_set(const char *theme);
3411    /**
3412     * Return a list of theme elements in the theme search path
3413     *
3414     * @return A list of strings that are the theme element names.
3415     *
3416     * This lists all available theme files in the standard Elementary search path
3417     * for theme elements, and returns them in alphabetical order as theme
3418     * element names in a list of strings. Free this with
3419     * elm_theme_name_available_list_free() when you are done with the list.
3420     */
3421    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3422    /**
3423     * Free the list returned by elm_theme_name_available_list_new()
3424     *
3425     * This frees the list of themes returned by
3426     * elm_theme_name_available_list_new(). Once freed the list should no longer
3427     * be used. a new list mys be created.
3428     */
3429    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3430    /**
3431     * Set a specific theme to be used for this object and its children
3432     *
3433     * @param obj The object to set the theme on
3434     * @param th The theme to set
3435     *
3436     * This sets a specific theme that will be used for the given object and any
3437     * child objects it has. If @p th is NULL then the theme to be used is
3438     * cleared and the object will inherit its theme from its parent (which
3439     * ultimately will use the default theme if no specific themes are set).
3440     *
3441     * Use special themes with great care as this will annoy users and make
3442     * configuration difficult. Avoid any custom themes at all if it can be
3443     * helped.
3444     */
3445    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3446    /**
3447     * Get the specific theme to be used
3448     *
3449     * @param obj The object to get the specific theme from
3450     * @return The specifc theme set.
3451     *
3452     * This will return a specific theme set, or NULL if no specific theme is
3453     * set on that object. It will not return inherited themes from parents, only
3454     * the specific theme set for that specific object. See elm_object_theme_set()
3455     * for more information.
3456     */
3457    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3458
3459    /**
3460     * Get a data item from a theme
3461     *
3462     * @param th The theme, or NULL for default theme
3463     * @param key The data key to search with
3464     * @return The data value, or NULL on failure
3465     *
3466     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3467     * It works the same way as edje_file_data_get() except that the return is stringshared.
3468     */
3469    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3470    /**
3471     * @}
3472     */
3473
3474    /* win */
3475    /** @defgroup Win Win
3476     *
3477     * @image html img/widget/win/preview-00.png
3478     * @image latex img/widget/win/preview-00.eps
3479     *
3480     * The window class of Elementary.  Contains functions to manipulate
3481     * windows. The Evas engine used to render the window contents is specified
3482     * in the system or user elementary config files (whichever is found last),
3483     * and can be overridden with the ELM_ENGINE environment variable for
3484     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3485     * compilation setup and modules actually installed at runtime) are (listed
3486     * in order of best supported and most likely to be complete and work to
3487     * lowest quality).
3488     *
3489     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3490     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3491     * rendering in X11)
3492     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3493     * exits)
3494     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3495     * rendering)
3496     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3497     * buffer)
3498     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3499     * rendering using SDL as the buffer)
3500     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3501     * GDI with software)
3502     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3503     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3504     * grayscale using dedicated 8bit software engine in X11)
3505     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3506     * X11 using 16bit software engine)
3507     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3508     * (Windows CE rendering via GDI with 16bit software renderer)
3509     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3510     * buffer with 16bit software renderer)
3511     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3512     *
3513     * All engines use a simple string to select the engine to render, EXCEPT
3514     * the "shot" engine. This actually encodes the output of the virtual
3515     * screenshot and how long to delay in the engine string. The engine string
3516     * is encoded in the following way:
3517     *
3518     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3519     *
3520     * Where options are separated by a ":" char if more than one option is
3521     * given, with delay, if provided being the first option and file the last
3522     * (order is important). The delay specifies how long to wait after the
3523     * window is shown before doing the virtual "in memory" rendering and then
3524     * save the output to the file specified by the file option (and then exit).
3525     * If no delay is given, the default is 0.5 seconds. If no file is given the
3526     * default output file is "out.png". Repeat option is for continous
3527     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3528     * fixed to "out001.png" Some examples of using the shot engine:
3529     *
3530     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3531     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3532     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3533     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3534     *   ELM_ENGINE="shot:" elementary_test
3535     *
3536     * Signals that you can add callbacks for are:
3537     *
3538     * @li "delete,request": the user requested to close the window. See
3539     * elm_win_autodel_set().
3540     * @li "focus,in": window got focus
3541     * @li "focus,out": window lost focus
3542     * @li "moved": window that holds the canvas was moved
3543     *
3544     * Examples:
3545     * @li @ref win_example_01
3546     *
3547     * @{
3548     */
3549    /**
3550     * Defines the types of window that can be created
3551     *
3552     * These are hints set on the window so that a running Window Manager knows
3553     * how the window should be handled and/or what kind of decorations it
3554     * should have.
3555     *
3556     * Currently, only the X11 backed engines use them.
3557     */
3558    typedef enum _Elm_Win_Type
3559      {
3560         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3561                          window. Almost every window will be created with this
3562                          type. */
3563         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3564         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3565                            window holding desktop icons. */
3566         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3567                         be kept on top of any other window by the Window
3568                         Manager. */
3569         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3570                            similar. */
3571         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3572         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3573                            pallete. */
3574         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3575         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3576                                  entry in a menubar is clicked. Typically used
3577                                  with elm_win_override_set(). This hint exists
3578                                  for completion only, as the EFL way of
3579                                  implementing a menu would not normally use a
3580                                  separate window for its contents. */
3581         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3582                               triggered by right-clicking an object. */
3583         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3584                            explanatory text that typically appear after the
3585                            mouse cursor hovers over an object for a while.
3586                            Typically used with elm_win_override_set() and also
3587                            not very commonly used in the EFL. */
3588         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3589                                 battery life or a new E-Mail received. */
3590         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3591                          usually used in the EFL. */
3592         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3593                        object being dragged across different windows, or even
3594                        applications. Typically used with
3595                        elm_win_override_set(). */
3596         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3597                                  buffer. No actual window is created for this
3598                                  type, instead the window and all of its
3599                                  contents will be rendered to an image buffer.
3600                                  This allows to have children window inside a
3601                                  parent one just like any other object would
3602                                  be, and do other things like applying @c
3603                                  Evas_Map effects to it. This is the only type
3604                                  of window that requires the @c parent
3605                                  parameter of elm_win_add() to be a valid @c
3606                                  Evas_Object. */
3607      } Elm_Win_Type;
3608
3609    /**
3610     * The differents layouts that can be requested for the virtual keyboard.
3611     *
3612     * When the application window is being managed by Illume, it may request
3613     * any of the following layouts for the virtual keyboard.
3614     */
3615    typedef enum _Elm_Win_Keyboard_Mode
3616      {
3617         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3618         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3619         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3620         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3621         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3622         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3623         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3624         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3625         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3626         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3627         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3628         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3629         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3630         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3631         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3632         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3633      } Elm_Win_Keyboard_Mode;
3634
3635    /**
3636     * Available commands that can be sent to the Illume manager.
3637     *
3638     * When running under an Illume session, a window may send commands to the
3639     * Illume manager to perform different actions.
3640     */
3641    typedef enum _Elm_Illume_Command
3642      {
3643         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3644                                          window */
3645         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3646                                             in the list */
3647         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3648                                          screen */
3649         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3650      } Elm_Illume_Command;
3651
3652    /**
3653     * Adds a window object. If this is the first window created, pass NULL as
3654     * @p parent.
3655     *
3656     * @param parent Parent object to add the window to, or NULL
3657     * @param name The name of the window
3658     * @param type The window type, one of #Elm_Win_Type.
3659     *
3660     * The @p parent paramter can be @c NULL for every window @p type except
3661     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3662     * which the image object will be created.
3663     *
3664     * @return The created object, or NULL on failure
3665     */
3666    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3667    /**
3668     * Add @p subobj as a resize object of window @p obj.
3669     *
3670     *
3671     * Setting an object as a resize object of the window means that the
3672     * @p subobj child's size and position will be controlled by the window
3673     * directly. That is, the object will be resized to match the window size
3674     * and should never be moved or resized manually by the developer.
3675     *
3676     * In addition, resize objects of the window control what the minimum size
3677     * of it will be, as well as whether it can or not be resized by the user.
3678     *
3679     * For the end user to be able to resize a window by dragging the handles
3680     * or borders provided by the Window Manager, or using any other similar
3681     * mechanism, all of the resize objects in the window should have their
3682     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3683     *
3684     * @param obj The window object
3685     * @param subobj The resize object to add
3686     */
3687    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3688    /**
3689     * Delete @p subobj as a resize object of window @p obj.
3690     *
3691     * This function removes the object @p subobj from the resize objects of
3692     * the window @p obj. It will not delete the object itself, which will be
3693     * left unmanaged and should be deleted by the developer, manually handled
3694     * or set as child of some other container.
3695     *
3696     * @param obj The window object
3697     * @param subobj The resize object to add
3698     */
3699    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3700    /**
3701     * Set the title of the window
3702     *
3703     * @param obj The window object
3704     * @param title The title to set
3705     */
3706    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3707    /**
3708     * Get the title of the window
3709     *
3710     * The returned string is an internal one and should not be freed or
3711     * modified. It will also be rendered invalid if a new title is set or if
3712     * the window is destroyed.
3713     *
3714     * @param obj The window object
3715     * @return The title
3716     */
3717    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3718    /**
3719     * Set the window's autodel state.
3720     *
3721     * When closing the window in any way outside of the program control, like
3722     * pressing the X button in the titlebar or using a command from the
3723     * Window Manager, a "delete,request" signal is emitted to indicate that
3724     * this event occurred and the developer can take any action, which may
3725     * include, or not, destroying the window object.
3726     *
3727     * When the @p autodel parameter is set, the window will be automatically
3728     * destroyed when this event occurs, after the signal is emitted.
3729     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3730     * and is up to the program to do so when it's required.
3731     *
3732     * @param obj The window object
3733     * @param autodel If true, the window will automatically delete itself when
3734     * closed
3735     */
3736    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3737    /**
3738     * Get the window's autodel state.
3739     *
3740     * @param obj The window object
3741     * @return If the window will automatically delete itself when closed
3742     *
3743     * @see elm_win_autodel_set()
3744     */
3745    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3746    /**
3747     * Activate a window object.
3748     *
3749     * This function sends a request to the Window Manager to activate the
3750     * window pointed by @p obj. If honored by the WM, the window will receive
3751     * the keyboard focus.
3752     *
3753     * @note This is just a request that a Window Manager may ignore, so calling
3754     * this function does not ensure in any way that the window will be the
3755     * active one after it.
3756     *
3757     * @param obj The window object
3758     */
3759    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3760    /**
3761     * Lower a window object.
3762     *
3763     * Places the window pointed by @p obj at the bottom of the stack, so that
3764     * no other window is covered by it.
3765     *
3766     * If elm_win_override_set() is not set, the Window Manager may ignore this
3767     * request.
3768     *
3769     * @param obj The window object
3770     */
3771    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3772    /**
3773     * Raise a window object.
3774     *
3775     * Places the window pointed by @p obj at the top of the stack, so that it's
3776     * not covered by any other window.
3777     *
3778     * If elm_win_override_set() is not set, the Window Manager may ignore this
3779     * request.
3780     *
3781     * @param obj The window object
3782     */
3783    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3784    /**
3785     * Set the borderless state of a window.
3786     *
3787     * This function requests the Window Manager to not draw any decoration
3788     * around the window.
3789     *
3790     * @param obj The window object
3791     * @param borderless If true, the window is borderless
3792     */
3793    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3794    /**
3795     * Get the borderless state of a window.
3796     *
3797     * @param obj The window object
3798     * @return If true, the window is borderless
3799     */
3800    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3801    /**
3802     * Set the shaped state of a window.
3803     *
3804     * Shaped windows, when supported, will render the parts of the window that
3805     * has no content, transparent.
3806     *
3807     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3808     * background object or cover the entire window in any other way, or the
3809     * parts of the canvas that have no data will show framebuffer artifacts.
3810     *
3811     * @param obj The window object
3812     * @param shaped If true, the window is shaped
3813     *
3814     * @see elm_win_alpha_set()
3815     */
3816    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3817    /**
3818     * Get the shaped state of a window.
3819     *
3820     * @param obj The window object
3821     * @return If true, the window is shaped
3822     *
3823     * @see elm_win_shaped_set()
3824     */
3825    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3826    /**
3827     * Set the alpha channel state of a window.
3828     *
3829     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3830     * possibly making parts of the window completely or partially transparent.
3831     * This is also subject to the underlying system supporting it, like for
3832     * example, running under a compositing manager. If no compositing is
3833     * available, enabling this option will instead fallback to using shaped
3834     * windows, with elm_win_shaped_set().
3835     *
3836     * @param obj The window object
3837     * @param alpha If true, the window has an alpha channel
3838     *
3839     * @see elm_win_alpha_set()
3840     */
3841    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3842    /**
3843     * Get the transparency state of a window.
3844     *
3845     * @param obj The window object
3846     * @return If true, the window is transparent
3847     *
3848     * @see elm_win_transparent_set()
3849     */
3850    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3851    /**
3852     * Set the transparency state of a window.
3853     *
3854     * Use elm_win_alpha_set() instead.
3855     *
3856     * @param obj The window object
3857     * @param transparent If true, the window is transparent
3858     *
3859     * @see elm_win_alpha_set()
3860     */
3861    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3862    /**
3863     * Get the alpha channel state of a window.
3864     *
3865     * @param obj The window object
3866     * @return If true, the window has an alpha channel
3867     */
3868    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3869    /**
3870     * Set the override state of a window.
3871     *
3872     * A window with @p override set to EINA_TRUE will not be managed by the
3873     * Window Manager. This means that no decorations of any kind will be shown
3874     * for it, moving and resizing must be handled by the application, as well
3875     * as the window visibility.
3876     *
3877     * This should not be used for normal windows, and even for not so normal
3878     * ones, it should only be used when there's a good reason and with a lot
3879     * of care. Mishandling override windows may result situations that
3880     * disrupt the normal workflow of the end user.
3881     *
3882     * @param obj The window object
3883     * @param override If true, the window is overridden
3884     */
3885    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3886    /**
3887     * Get the override state of a window.
3888     *
3889     * @param obj The window object
3890     * @return If true, the window is overridden
3891     *
3892     * @see elm_win_override_set()
3893     */
3894    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3895    /**
3896     * Set the fullscreen state of a window.
3897     *
3898     * @param obj The window object
3899     * @param fullscreen If true, the window is fullscreen
3900     */
3901    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3902    /**
3903     * Get the fullscreen state of a window.
3904     *
3905     * @param obj The window object
3906     * @return If true, the window is fullscreen
3907     */
3908    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3909    /**
3910     * Set the maximized state of a window.
3911     *
3912     * @param obj The window object
3913     * @param maximized If true, the window is maximized
3914     */
3915    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3916    /**
3917     * Get the maximized state of a window.
3918     *
3919     * @param obj The window object
3920     * @return If true, the window is maximized
3921     */
3922    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3923    /**
3924     * Set the iconified state of a window.
3925     *
3926     * @param obj The window object
3927     * @param iconified If true, the window is iconified
3928     */
3929    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3930    /**
3931     * Get the iconified state of a window.
3932     *
3933     * @param obj The window object
3934     * @return If true, the window is iconified
3935     */
3936    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3937    /**
3938     * Set the layer of the window.
3939     *
3940     * What this means exactly will depend on the underlying engine used.
3941     *
3942     * In the case of X11 backed engines, the value in @p layer has the
3943     * following meanings:
3944     * @li < 3: The window will be placed below all others.
3945     * @li > 5: The window will be placed above all others.
3946     * @li other: The window will be placed in the default layer.
3947     *
3948     * @param obj The window object
3949     * @param layer The layer of the window
3950     */
3951    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3952    /**
3953     * Get the layer of the window.
3954     *
3955     * @param obj The window object
3956     * @return The layer of the window
3957     *
3958     * @see elm_win_layer_set()
3959     */
3960    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961    /**
3962     * Set the rotation of the window.
3963     *
3964     * Most engines only work with multiples of 90.
3965     *
3966     * This function is used to set the orientation of the window @p obj to
3967     * match that of the screen. The window itself will be resized to adjust
3968     * to the new geometry of its contents. If you want to keep the window size,
3969     * see elm_win_rotation_with_resize_set().
3970     *
3971     * @param obj The window object
3972     * @param rotation The rotation of the window, in degrees (0-360),
3973     * counter-clockwise.
3974     */
3975    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3976    /**
3977     * Rotates the window and resizes it.
3978     *
3979     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3980     * that they fit inside the current window geometry.
3981     *
3982     * @param obj The window object
3983     * @param layer The rotation of the window in degrees (0-360),
3984     * counter-clockwise.
3985     */
3986    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3987    /**
3988     * Get the rotation of the window.
3989     *
3990     * @param obj The window object
3991     * @return The rotation of the window in degrees (0-360)
3992     *
3993     * @see elm_win_rotation_set()
3994     * @see elm_win_rotation_with_resize_set()
3995     */
3996    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3997    /**
3998     * Set the sticky state of the window.
3999     *
4000     * Hints the Window Manager that the window in @p obj should be left fixed
4001     * at its position even when the virtual desktop it's on moves or changes.
4002     *
4003     * @param obj The window object
4004     * @param sticky If true, the window's sticky state is enabled
4005     */
4006    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4007    /**
4008     * Get the sticky state of the window.
4009     *
4010     * @param obj The window object
4011     * @return If true, the window's sticky state is enabled
4012     *
4013     * @see elm_win_sticky_set()
4014     */
4015    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4016    /**
4017     * Set if this window is an illume conformant window
4018     *
4019     * @param obj The window object
4020     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4021     */
4022    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4023    /**
4024     * Get if this window is an illume conformant window
4025     *
4026     * @param obj The window object
4027     * @return A boolean if this window is illume conformant or not
4028     */
4029    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4030    /**
4031     * Set a window to be an illume quickpanel window
4032     *
4033     * By default window objects are not quickpanel windows.
4034     *
4035     * @param obj The window object
4036     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4037     */
4038    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4039    /**
4040     * Get if this window is a quickpanel or not
4041     *
4042     * @param obj The window object
4043     * @return A boolean if this window is a quickpanel or not
4044     */
4045    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4046    /**
4047     * Set the major priority of a quickpanel window
4048     *
4049     * @param obj The window object
4050     * @param priority The major priority for this quickpanel
4051     */
4052    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4053    /**
4054     * Get the major priority of a quickpanel window
4055     *
4056     * @param obj The window object
4057     * @return The major priority of this quickpanel
4058     */
4059    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4060    /**
4061     * Set the minor priority of a quickpanel window
4062     *
4063     * @param obj The window object
4064     * @param priority The minor priority for this quickpanel
4065     */
4066    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4067    /**
4068     * Get the minor priority of a quickpanel window
4069     *
4070     * @param obj The window object
4071     * @return The minor priority of this quickpanel
4072     */
4073    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4074    /**
4075     * Set which zone this quickpanel should appear in
4076     *
4077     * @param obj The window object
4078     * @param zone The requested zone for this quickpanel
4079     */
4080    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4081    /**
4082     * Get which zone this quickpanel should appear in
4083     *
4084     * @param obj The window object
4085     * @return The requested zone for this quickpanel
4086     */
4087    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4088    /**
4089     * Set the window to be skipped by keyboard focus
4090     *
4091     * This sets the window to be skipped by normal keyboard input. This means
4092     * a window manager will be asked to not focus this window as well as omit
4093     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4094     *
4095     * Call this and enable it on a window BEFORE you show it for the first time,
4096     * otherwise it may have no effect.
4097     *
4098     * Use this for windows that have only output information or might only be
4099     * interacted with by the mouse or fingers, and never for typing input.
4100     * Be careful that this may have side-effects like making the window
4101     * non-accessible in some cases unless the window is specially handled. Use
4102     * this with care.
4103     *
4104     * @param obj The window object
4105     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4106     */
4107    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4108    /**
4109     * Send a command to the windowing environment
4110     *
4111     * This is intended to work in touchscreen or small screen device
4112     * environments where there is a more simplistic window management policy in
4113     * place. This uses the window object indicated to select which part of the
4114     * environment to control (the part that this window lives in), and provides
4115     * a command and an optional parameter structure (use NULL for this if not
4116     * needed).
4117     *
4118     * @param obj The window object that lives in the environment to control
4119     * @param command The command to send
4120     * @param params Optional parameters for the command
4121     */
4122    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4123    /**
4124     * Get the inlined image object handle
4125     *
4126     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4127     * then the window is in fact an evas image object inlined in the parent
4128     * canvas. You can get this object (be careful to not manipulate it as it
4129     * is under control of elementary), and use it to do things like get pixel
4130     * data, save the image to a file, etc.
4131     *
4132     * @param obj The window object to get the inlined image from
4133     * @return The inlined image object, or NULL if none exists
4134     */
4135    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4136    /**
4137     * Set the enabled status for the focus highlight in a window
4138     *
4139     * This function will enable or disable the focus highlight only for the
4140     * given window, regardless of the global setting for it
4141     *
4142     * @param obj The window where to enable the highlight
4143     * @param enabled The enabled value for the highlight
4144     */
4145    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4146    /**
4147     * Get the enabled value of the focus highlight for this window
4148     *
4149     * @param obj The window in which to check if the focus highlight is enabled
4150     *
4151     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4152     */
4153    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4154    /**
4155     * Set the style for the focus highlight on this window
4156     *
4157     * Sets the style to use for theming the highlight of focused objects on
4158     * the given window. If @p style is NULL, the default will be used.
4159     *
4160     * @param obj The window where to set the style
4161     * @param style The style to set
4162     */
4163    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4164    /**
4165     * Get the style set for the focus highlight object
4166     *
4167     * Gets the style set for this windows highilght object, or NULL if none
4168     * is set.
4169     *
4170     * @param obj The window to retrieve the highlights style from
4171     *
4172     * @return The style set or NULL if none was. Default is used in that case.
4173     */
4174    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4175    EAPI void         elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4176    EAPI int          elm_win_indicator_state_get(Evas_Object *obj);
4177    /*...
4178     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4179     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4180     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4181     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4182     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4183     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4184     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4185     *
4186     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4187     * (blank mouse, private mouse obj, defaultmouse)
4188     *
4189     */
4190    /**
4191     * Sets the keyboard mode of the window.
4192     *
4193     * @param obj The window object
4194     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4195     */
4196    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4197    /**
4198     * Gets the keyboard mode of the window.
4199     *
4200     * @param obj The window object
4201     * @return The mode, one of #Elm_Win_Keyboard_Mode
4202     */
4203    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4204    /**
4205     * Sets whether the window is a keyboard.
4206     *
4207     * @param obj The window object
4208     * @param is_keyboard If true, the window is a virtual keyboard
4209     */
4210    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4211    /**
4212     * Gets whether the window is a keyboard.
4213     *
4214     * @param obj The window object
4215     * @return If the window is a virtual keyboard
4216     */
4217    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4218
4219    /**
4220     * Get the screen position of a window.
4221     *
4222     * @param obj The window object
4223     * @param x The int to store the x coordinate to
4224     * @param y The int to store the y coordinate to
4225     */
4226    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4227    /**
4228     * @}
4229     */
4230
4231    /**
4232     * @defgroup Inwin Inwin
4233     *
4234     * @image html img/widget/inwin/preview-00.png
4235     * @image latex img/widget/inwin/preview-00.eps
4236     * @image html img/widget/inwin/preview-01.png
4237     * @image latex img/widget/inwin/preview-01.eps
4238     * @image html img/widget/inwin/preview-02.png
4239     * @image latex img/widget/inwin/preview-02.eps
4240     *
4241     * An inwin is a window inside a window that is useful for a quick popup.
4242     * It does not hover.
4243     *
4244     * It works by creating an object that will occupy the entire window, so it
4245     * must be created using an @ref Win "elm_win" as parent only. The inwin
4246     * object can be hidden or restacked below every other object if it's
4247     * needed to show what's behind it without destroying it. If this is done,
4248     * the elm_win_inwin_activate() function can be used to bring it back to
4249     * full visibility again.
4250     *
4251     * There are three styles available in the default theme. These are:
4252     * @li default: The inwin is sized to take over most of the window it's
4253     * placed in.
4254     * @li minimal: The size of the inwin will be the minimum necessary to show
4255     * its contents.
4256     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4257     * possible, but it's sized vertically the most it needs to fit its\
4258     * contents.
4259     *
4260     * Some examples of Inwin can be found in the following:
4261     * @li @ref inwin_example_01
4262     *
4263     * @{
4264     */
4265    /**
4266     * Adds an inwin to the current window
4267     *
4268     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4269     * Never call this function with anything other than the top-most window
4270     * as its parameter, unless you are fond of undefined behavior.
4271     *
4272     * After creating the object, the widget will set itself as resize object
4273     * for the window with elm_win_resize_object_add(), so when shown it will
4274     * appear to cover almost the entire window (how much of it depends on its
4275     * content and the style used). It must not be added into other container
4276     * objects and it needs not be moved or resized manually.
4277     *
4278     * @param parent The parent object
4279     * @return The new object or NULL if it cannot be created
4280     */
4281    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4282    /**
4283     * Activates an inwin object, ensuring its visibility
4284     *
4285     * This function will make sure that the inwin @p obj is completely visible
4286     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4287     * to the front. It also sets the keyboard focus to it, which will be passed
4288     * onto its content.
4289     *
4290     * The object's theme will also receive the signal "elm,action,show" with
4291     * source "elm".
4292     *
4293     * @param obj The inwin to activate
4294     */
4295    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4296    /**
4297     * Set the content of an inwin object.
4298     *
4299     * Once the content object is set, a previously set one will be deleted.
4300     * If you want to keep that old content object, use the
4301     * elm_win_inwin_content_unset() function.
4302     *
4303     * @param obj The inwin object
4304     * @param content The object to set as content
4305     */
4306    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4307    /**
4308     * Get the content of an inwin object.
4309     *
4310     * Return the content object which is set for this widget.
4311     *
4312     * The returned object is valid as long as the inwin is still alive and no
4313     * other content is set on it. Deleting the object will notify the inwin
4314     * about it and this one will be left empty.
4315     *
4316     * If you need to remove an inwin's content to be reused somewhere else,
4317     * see elm_win_inwin_content_unset().
4318     *
4319     * @param obj The inwin object
4320     * @return The content that is being used
4321     */
4322    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4323    /**
4324     * Unset the content of an inwin object.
4325     *
4326     * Unparent and return the content object which was set for this widget.
4327     *
4328     * @param obj The inwin object
4329     * @return The content that was being used
4330     */
4331    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4332    /**
4333     * @}
4334     */
4335    /* X specific calls - won't work on non-x engines (return 0) */
4336
4337    /**
4338     * Get the Ecore_X_Window of an Evas_Object
4339     *
4340     * @param obj The object
4341     *
4342     * @return The Ecore_X_Window of @p obj
4343     *
4344     * @ingroup Win
4345     */
4346    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4347
4348    /* smart callbacks called:
4349     * "delete,request" - the user requested to delete the window
4350     * "focus,in" - window got focus
4351     * "focus,out" - window lost focus
4352     * "moved" - window that holds the canvas was moved
4353     */
4354
4355    /**
4356     * @defgroup Bg Bg
4357     *
4358     * @image html img/widget/bg/preview-00.png
4359     * @image latex img/widget/bg/preview-00.eps
4360     *
4361     * @brief Background object, used for setting a solid color, image or Edje
4362     * group as background to a window or any container object.
4363     *
4364     * The bg object is used for setting a solid background to a window or
4365     * packing into any container object. It works just like an image, but has
4366     * some properties useful to a background, like setting it to tiled,
4367     * centered, scaled or stretched.
4368     * 
4369     * Default contents parts of the bg widget that you can use for are:
4370     * @li "elm.swallow.content" - overlay of the bg
4371     *
4372     * Here is some sample code using it:
4373     * @li @ref bg_01_example_page
4374     * @li @ref bg_02_example_page
4375     * @li @ref bg_03_example_page
4376     */
4377
4378    /* bg */
4379    typedef enum _Elm_Bg_Option
4380      {
4381         ELM_BG_OPTION_CENTER,  /**< center the background */
4382         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4383         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4384         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4385      } Elm_Bg_Option;
4386
4387    /**
4388     * Add a new background to the parent
4389     *
4390     * @param parent The parent object
4391     * @return The new object or NULL if it cannot be created
4392     *
4393     * @ingroup Bg
4394     */
4395    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4396
4397    /**
4398     * Set the file (image or edje) used for the background
4399     *
4400     * @param obj The bg object
4401     * @param file The file path
4402     * @param group Optional key (group in Edje) within the file
4403     *
4404     * This sets the image file used in the background object. The image (or edje)
4405     * will be stretched (retaining aspect if its an image file) to completely fill
4406     * the bg object. This may mean some parts are not visible.
4407     *
4408     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4409     * even if @p file is NULL.
4410     *
4411     * @ingroup Bg
4412     */
4413    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4414
4415    /**
4416     * Get the file (image or edje) used for the background
4417     *
4418     * @param obj The bg object
4419     * @param file The file path
4420     * @param group Optional key (group in Edje) within the file
4421     *
4422     * @ingroup Bg
4423     */
4424    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4425
4426    /**
4427     * Set the option used for the background image
4428     *
4429     * @param obj The bg object
4430     * @param option The desired background option (TILE, SCALE)
4431     *
4432     * This sets the option used for manipulating the display of the background
4433     * image. The image can be tiled or scaled.
4434     *
4435     * @ingroup Bg
4436     */
4437    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4438
4439    /**
4440     * Get the option used for the background image
4441     *
4442     * @param obj The bg object
4443     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4444     *
4445     * @ingroup Bg
4446     */
4447    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4448    /**
4449     * Set the option used for the background color
4450     *
4451     * @param obj The bg object
4452     * @param r
4453     * @param g
4454     * @param b
4455     *
4456     * This sets the color used for the background rectangle. Its range goes
4457     * from 0 to 255.
4458     *
4459     * @ingroup Bg
4460     */
4461    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4462    /**
4463     * Get the option used for the background color
4464     *
4465     * @param obj The bg object
4466     * @param r
4467     * @param g
4468     * @param b
4469     *
4470     * @ingroup Bg
4471     */
4472    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4473
4474    /**
4475     * Set the overlay object used for the background object.
4476     *
4477     * @param obj The bg object
4478     * @param overlay The overlay object
4479     *
4480     * This provides a way for elm_bg to have an 'overlay' that will be on top
4481     * of the bg. Once the over object is set, a previously set one will be
4482     * deleted, even if you set the new one to NULL. If you want to keep that
4483     * old content object, use the elm_bg_overlay_unset() function.
4484     *
4485     * @ingroup Bg
4486     */
4487
4488    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4489
4490    /**
4491     * Get the overlay object used for the background object.
4492     *
4493     * @param obj The bg object
4494     * @return The content that is being used
4495     *
4496     * Return the content object which is set for this widget
4497     *
4498     * @ingroup Bg
4499     */
4500    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4501
4502    /**
4503     * Get the overlay object used for the background object.
4504     *
4505     * @param obj The bg object
4506     * @return The content that was being used
4507     *
4508     * Unparent and return the overlay object which was set for this widget
4509     *
4510     * @ingroup Bg
4511     */
4512    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4513
4514    /**
4515     * Set the size of the pixmap representation of the image.
4516     *
4517     * This option just makes sense if an image is going to be set in the bg.
4518     *
4519     * @param obj The bg object
4520     * @param w The new width of the image pixmap representation.
4521     * @param h The new height of the image pixmap representation.
4522     *
4523     * This function sets a new size for pixmap representation of the given bg
4524     * image. It allows the image to be loaded already in the specified size,
4525     * reducing the memory usage and load time when loading a big image with load
4526     * size set to a smaller size.
4527     *
4528     * NOTE: this is just a hint, the real size of the pixmap may differ
4529     * depending on the type of image being loaded, being bigger than requested.
4530     *
4531     * @ingroup Bg
4532     */
4533    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4534    /* smart callbacks called:
4535     */
4536
4537    /**
4538     * @defgroup Icon Icon
4539     *
4540     * @image html img/widget/icon/preview-00.png
4541     * @image latex img/widget/icon/preview-00.eps
4542     *
4543     * An object that provides standard icon images (delete, edit, arrows, etc.)
4544     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4545     *
4546     * The icon image requested can be in the elementary theme, or in the
4547     * freedesktop.org paths. It's possible to set the order of preference from
4548     * where the image will be used.
4549     *
4550     * This API is very similar to @ref Image, but with ready to use images.
4551     *
4552     * Default images provided by the theme are described below.
4553     *
4554     * The first list contains icons that were first intended to be used in
4555     * toolbars, but can be used in many other places too:
4556     * @li home
4557     * @li close
4558     * @li apps
4559     * @li arrow_up
4560     * @li arrow_down
4561     * @li arrow_left
4562     * @li arrow_right
4563     * @li chat
4564     * @li clock
4565     * @li delete
4566     * @li edit
4567     * @li refresh
4568     * @li folder
4569     * @li file
4570     *
4571     * Now some icons that were designed to be used in menus (but again, you can
4572     * use them anywhere else):
4573     * @li menu/home
4574     * @li menu/close
4575     * @li menu/apps
4576     * @li menu/arrow_up
4577     * @li menu/arrow_down
4578     * @li menu/arrow_left
4579     * @li menu/arrow_right
4580     * @li menu/chat
4581     * @li menu/clock
4582     * @li menu/delete
4583     * @li menu/edit
4584     * @li menu/refresh
4585     * @li menu/folder
4586     * @li menu/file
4587     *
4588     * And here we have some media player specific icons:
4589     * @li media_player/forward
4590     * @li media_player/info
4591     * @li media_player/next
4592     * @li media_player/pause
4593     * @li media_player/play
4594     * @li media_player/prev
4595     * @li media_player/rewind
4596     * @li media_player/stop
4597     *
4598     * Signals that you can add callbacks for are:
4599     *
4600     * "clicked" - This is called when a user has clicked the icon
4601     *
4602     * An example of usage for this API follows:
4603     * @li @ref tutorial_icon
4604     */
4605
4606    /**
4607     * @addtogroup Icon
4608     * @{
4609     */
4610
4611    typedef enum _Elm_Icon_Type
4612      {
4613         ELM_ICON_NONE,
4614         ELM_ICON_FILE,
4615         ELM_ICON_STANDARD
4616      } Elm_Icon_Type;
4617    /**
4618     * @enum _Elm_Icon_Lookup_Order
4619     * @typedef Elm_Icon_Lookup_Order
4620     *
4621     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4622     * theme, FDO paths, or both?
4623     *
4624     * @ingroup Icon
4625     */
4626    typedef enum _Elm_Icon_Lookup_Order
4627      {
4628         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4629         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4630         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4631         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4632      } Elm_Icon_Lookup_Order;
4633
4634    /**
4635     * Add a new icon object to the parent.
4636     *
4637     * @param parent The parent object
4638     * @return The new object or NULL if it cannot be created
4639     *
4640     * @see elm_icon_file_set()
4641     *
4642     * @ingroup Icon
4643     */
4644    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4645    /**
4646     * Set the file that will be used as icon.
4647     *
4648     * @param obj The icon object
4649     * @param file The path to file that will be used as icon image
4650     * @param group The group that the icon belongs to an edje file
4651     *
4652     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4653     *
4654     * @note The icon image set by this function can be changed by
4655     * elm_icon_standard_set().
4656     *
4657     * @see elm_icon_file_get()
4658     *
4659     * @ingroup Icon
4660     */
4661    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4662    /**
4663     * Set a location in memory to be used as an icon
4664     *
4665     * @param obj The icon object
4666     * @param img The binary data that will be used as an image
4667     * @param size The size of binary data @p img
4668     * @param format Optional format of @p img to pass to the image loader
4669     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4670     *
4671     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4672     *
4673     * @note The icon image set by this function can be changed by
4674     * elm_icon_standard_set().
4675     *
4676     * @ingroup Icon
4677     */
4678    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);
4679    /**
4680     * Get the file that will be used as icon.
4681     *
4682     * @param obj The icon object
4683     * @param file The path to file that will be used as the icon image
4684     * @param group The group that the icon belongs to, in edje file
4685     *
4686     * @see elm_icon_file_set()
4687     *
4688     * @ingroup Icon
4689     */
4690    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4691    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4692    /**
4693     * Set the icon by icon standards names.
4694     *
4695     * @param obj The icon object
4696     * @param name The icon name
4697     *
4698     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4699     *
4700     * For example, freedesktop.org defines standard icon names such as "home",
4701     * "network", etc. There can be different icon sets to match those icon
4702     * keys. The @p name given as parameter is one of these "keys", and will be
4703     * used to look in the freedesktop.org paths and elementary theme. One can
4704     * change the lookup order with elm_icon_order_lookup_set().
4705     *
4706     * If name is not found in any of the expected locations and it is the
4707     * absolute path of an image file, this image will be used.
4708     *
4709     * @note The icon image set by this function can be changed by
4710     * elm_icon_file_set().
4711     *
4712     * @see elm_icon_standard_get()
4713     * @see elm_icon_file_set()
4714     *
4715     * @ingroup Icon
4716     */
4717    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4718    /**
4719     * Get the icon name set by icon standard names.
4720     *
4721     * @param obj The icon object
4722     * @return The icon name
4723     *
4724     * If the icon image was set using elm_icon_file_set() instead of
4725     * elm_icon_standard_set(), then this function will return @c NULL.
4726     *
4727     * @see elm_icon_standard_set()
4728     *
4729     * @ingroup Icon
4730     */
4731    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4732    /**
4733     * Set the smooth scaling for an icon object.
4734     *
4735     * @param obj The icon object
4736     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4737     * otherwise. Default is @c EINA_TRUE.
4738     *
4739     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4740     * scaling provides a better resulting image, but is slower.
4741     *
4742     * The smooth scaling should be disabled when making animations that change
4743     * the icon size, since they will be faster. Animations that don't require
4744     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4745     * is already scaled, since the scaled icon image will be cached).
4746     *
4747     * @see elm_icon_smooth_get()
4748     *
4749     * @ingroup Icon
4750     */
4751    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4752    /**
4753     * Get whether smooth scaling is enabled for an icon object.
4754     *
4755     * @param obj The icon object
4756     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4757     *
4758     * @see elm_icon_smooth_set()
4759     *
4760     * @ingroup Icon
4761     */
4762    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4763    /**
4764     * Disable scaling of this object.
4765     *
4766     * @param obj The icon object.
4767     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4768     * otherwise. Default is @c EINA_FALSE.
4769     *
4770     * This function disables scaling of the icon object through the function
4771     * elm_object_scale_set(). However, this does not affect the object
4772     * size/resize in any way. For that effect, take a look at
4773     * elm_icon_scale_set().
4774     *
4775     * @see elm_icon_no_scale_get()
4776     * @see elm_icon_scale_set()
4777     * @see elm_object_scale_set()
4778     *
4779     * @ingroup Icon
4780     */
4781    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4782    /**
4783     * Get whether scaling is disabled on the object.
4784     *
4785     * @param obj The icon object
4786     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4787     *
4788     * @see elm_icon_no_scale_set()
4789     *
4790     * @ingroup Icon
4791     */
4792    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4793    /**
4794     * Set if the object is (up/down) resizable.
4795     *
4796     * @param obj The icon object
4797     * @param scale_up A bool to set if the object is resizable up. Default is
4798     * @c EINA_TRUE.
4799     * @param scale_down A bool to set if the object is resizable down. Default
4800     * is @c EINA_TRUE.
4801     *
4802     * This function limits the icon object resize ability. If @p scale_up is set to
4803     * @c EINA_FALSE, the object can't have its height or width resized to a value
4804     * higher than the original icon size. Same is valid for @p scale_down.
4805     *
4806     * @see elm_icon_scale_get()
4807     *
4808     * @ingroup Icon
4809     */
4810    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4811    /**
4812     * Get if the object is (up/down) resizable.
4813     *
4814     * @param obj The icon object
4815     * @param scale_up A bool to set if the object is resizable up
4816     * @param scale_down A bool to set if the object is resizable down
4817     *
4818     * @see elm_icon_scale_set()
4819     *
4820     * @ingroup Icon
4821     */
4822    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4823    /**
4824     * Get the object's image size
4825     *
4826     * @param obj The icon object
4827     * @param w A pointer to store the width in
4828     * @param h A pointer to store the height in
4829     *
4830     * @ingroup Icon
4831     */
4832    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4833    /**
4834     * Set if the icon fill the entire object area.
4835     *
4836     * @param obj The icon object
4837     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4838     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4839     *
4840     * When the icon object is resized to a different aspect ratio from the
4841     * original icon image, the icon image will still keep its aspect. This flag
4842     * tells how the image should fill the object's area. They are: keep the
4843     * entire icon inside the limits of height and width of the object (@p
4844     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4845     * of the object, and the icon will fill the entire object (@p fill_outside
4846     * is @c EINA_TRUE).
4847     *
4848     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4849     * retain property to false. Thus, the icon image will always keep its
4850     * original aspect ratio.
4851     *
4852     * @see elm_icon_fill_outside_get()
4853     * @see elm_image_fill_outside_set()
4854     *
4855     * @ingroup Icon
4856     */
4857    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4858    /**
4859     * Get if the object is filled outside.
4860     *
4861     * @param obj The icon object
4862     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4863     *
4864     * @see elm_icon_fill_outside_set()
4865     *
4866     * @ingroup Icon
4867     */
4868    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4869    /**
4870     * Set the prescale size for the icon.
4871     *
4872     * @param obj The icon object
4873     * @param size The prescale size. This value is used for both width and
4874     * height.
4875     *
4876     * This function sets a new size for pixmap representation of the given
4877     * icon. It allows the icon to be loaded already in the specified size,
4878     * reducing the memory usage and load time when loading a big icon with load
4879     * size set to a smaller size.
4880     *
4881     * It's equivalent to the elm_bg_load_size_set() function for bg.
4882     *
4883     * @note this is just a hint, the real size of the pixmap may differ
4884     * depending on the type of icon being loaded, being bigger than requested.
4885     *
4886     * @see elm_icon_prescale_get()
4887     * @see elm_bg_load_size_set()
4888     *
4889     * @ingroup Icon
4890     */
4891    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4892    /**
4893     * Get the prescale size for the icon.
4894     *
4895     * @param obj The icon object
4896     * @return The prescale size
4897     *
4898     * @see elm_icon_prescale_set()
4899     *
4900     * @ingroup Icon
4901     */
4902    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4903    /**
4904     * Sets the icon lookup order used by elm_icon_standard_set().
4905     *
4906     * @param obj The icon object
4907     * @param order The icon lookup order (can be one of
4908     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4909     * or ELM_ICON_LOOKUP_THEME)
4910     *
4911     * @see elm_icon_order_lookup_get()
4912     * @see Elm_Icon_Lookup_Order
4913     *
4914     * @ingroup Icon
4915     */
4916    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4917    /**
4918     * Gets the icon lookup order.
4919     *
4920     * @param obj The icon object
4921     * @return The icon lookup order
4922     *
4923     * @see elm_icon_order_lookup_set()
4924     * @see Elm_Icon_Lookup_Order
4925     *
4926     * @ingroup Icon
4927     */
4928    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4929    /**
4930     * Get if the icon supports animation or not.
4931     *
4932     * @param obj The icon object
4933     * @return @c EINA_TRUE if the icon supports animation,
4934     *         @c EINA_FALSE otherwise.
4935     *
4936     * Return if this elm icon's image can be animated. Currently Evas only
4937     * supports gif animation. If the return value is EINA_FALSE, other
4938     * elm_icon_animated_XXX APIs won't work.
4939     * @ingroup Icon
4940     */
4941    EAPI Eina_Bool             elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4942    /**
4943     * Set animation mode of the icon.
4944     *
4945     * @param obj The icon object
4946     * @param anim @c EINA_TRUE if the object do animation job,
4947     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4948     *
4949     * Since the default animation mode is set to EINA_FALSE, 
4950     * the icon is shown without animation.
4951     * This might be desirable when the application developer wants to show
4952     * a snapshot of the animated icon.
4953     * Set it to EINA_TRUE when the icon needs to be animated.
4954     * @ingroup Icon
4955     */
4956    EAPI void                  elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
4957    /**
4958     * Get animation mode of the icon.
4959     *
4960     * @param obj The icon object
4961     * @return The animation mode of the icon object
4962     * @see elm_icon_animated_set
4963     * @ingroup Icon
4964     */
4965    EAPI Eina_Bool             elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4966    /**
4967     * Set animation play mode of the icon.
4968     *
4969     * @param obj The icon object
4970     * @param play @c EINA_TRUE the object play animation images,
4971     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4972     *
4973     * To play elm icon's animation, set play to EINA_TURE.
4974     * For example, you make gif player using this set/get API and click event.
4975     *
4976     * 1. Click event occurs
4977     * 2. Check play flag using elm_icon_animaged_play_get
4978     * 3. If elm icon was playing, set play to EINA_FALSE.
4979     *    Then animation will be stopped and vice versa
4980     * @ingroup Icon
4981     */
4982    EAPI void                  elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4983    /**
4984     * Get animation play mode of the icon.
4985     *
4986     * @param obj The icon object
4987     * @return The play mode of the icon object
4988     *
4989     * @see elm_icon_animated_play_get
4990     * @ingroup Icon
4991     */
4992    EAPI Eina_Bool             elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4993
4994    /**
4995     * @}
4996     */
4997
4998    /**
4999     * @addtogroup Image
5000     * @{
5001     */
5002
5003    /**
5004     * @enum _Elm_Image_Orient
5005     * @typedef Elm_Image_Orient
5006     *
5007     * Possible orientation options for elm_image_orient_set().
5008     *
5009     * @image html elm_image_orient_set.png
5010     * @image latex elm_image_orient_set.eps width=\textwidth
5011     *
5012     * @ingroup Image
5013     */
5014    typedef enum _Elm_Image_Orient
5015      {
5016         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5017         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5018         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5019         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5020         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5021         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5022         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5023         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5024      } Elm_Image_Orient;
5025
5026    /**
5027     * Add a new image to the parent.
5028     *
5029     * @param parent The parent object
5030     * @return The new object or NULL if it cannot be created
5031     *
5032     * @see elm_image_file_set()
5033     *
5034     * @ingroup Image
5035     */
5036    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5037    /**
5038     * Set the file that will be used as image.
5039     *
5040     * @param obj The image object
5041     * @param file The path to file that will be used as image
5042     * @param group The group that the image belongs in edje file (if it's an
5043     * edje image)
5044     *
5045     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5046     *
5047     * @see elm_image_file_get()
5048     *
5049     * @ingroup Image
5050     */
5051    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5052    /**
5053     * Get the file that will be used as image.
5054     *
5055     * @param obj The image object
5056     * @param file The path to file
5057     * @param group The group that the image belongs in edje file
5058     *
5059     * @see elm_image_file_set()
5060     *
5061     * @ingroup Image
5062     */
5063    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5064    /**
5065     * Set the smooth effect for an image.
5066     *
5067     * @param obj The image object
5068     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5069     * otherwise. Default is @c EINA_TRUE.
5070     *
5071     * Set the scaling algorithm to be used when scaling the image. Smooth
5072     * scaling provides a better resulting image, but is slower.
5073     *
5074     * The smooth scaling should be disabled when making animations that change
5075     * the image size, since it will be faster. Animations that don't require
5076     * resizing of the image can keep the smooth scaling enabled (even if the
5077     * image is already scaled, since the scaled image will be cached).
5078     *
5079     * @see elm_image_smooth_get()
5080     *
5081     * @ingroup Image
5082     */
5083    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5084    /**
5085     * Get the smooth effect for an image.
5086     *
5087     * @param obj The image object
5088     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5089     *
5090     * @see elm_image_smooth_get()
5091     *
5092     * @ingroup Image
5093     */
5094    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5095
5096    /**
5097     * Gets the current size of the image.
5098     *
5099     * @param obj The image object.
5100     * @param w Pointer to store width, or NULL.
5101     * @param h Pointer to store height, or NULL.
5102     *
5103     * This is the real size of the image, not the size of the object.
5104     *
5105     * On error, neither w or h will be written.
5106     *
5107     * @ingroup Image
5108     */
5109    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5110    /**
5111     * Disable scaling of this object.
5112     *
5113     * @param obj The image object.
5114     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5115     * otherwise. Default is @c EINA_FALSE.
5116     *
5117     * This function disables scaling of the elm_image widget through the
5118     * function elm_object_scale_set(). However, this does not affect the widget
5119     * size/resize in any way. For that effect, take a look at
5120     * elm_image_scale_set().
5121     *
5122     * @see elm_image_no_scale_get()
5123     * @see elm_image_scale_set()
5124     * @see elm_object_scale_set()
5125     *
5126     * @ingroup Image
5127     */
5128    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5129    /**
5130     * Get whether scaling is disabled on the object.
5131     *
5132     * @param obj The image object
5133     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5134     *
5135     * @see elm_image_no_scale_set()
5136     *
5137     * @ingroup Image
5138     */
5139    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5140    /**
5141     * Set if the object is (up/down) resizable.
5142     *
5143     * @param obj The image object
5144     * @param scale_up A bool to set if the object is resizable up. Default is
5145     * @c EINA_TRUE.
5146     * @param scale_down A bool to set if the object is resizable down. Default
5147     * is @c EINA_TRUE.
5148     *
5149     * This function limits the image resize ability. If @p scale_up is set to
5150     * @c EINA_FALSE, the object can't have its height or width resized to a value
5151     * higher than the original image size. Same is valid for @p scale_down.
5152     *
5153     * @see elm_image_scale_get()
5154     *
5155     * @ingroup Image
5156     */
5157    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5158    /**
5159     * Get if the object is (up/down) resizable.
5160     *
5161     * @param obj The image object
5162     * @param scale_up A bool to set if the object is resizable up
5163     * @param scale_down A bool to set if the object is resizable down
5164     *
5165     * @see elm_image_scale_set()
5166     *
5167     * @ingroup Image
5168     */
5169    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5170    /**
5171     * Set if the image fills the entire object area, when keeping the aspect ratio.
5172     *
5173     * @param obj The image object
5174     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5175     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5176     *
5177     * When the image should keep its aspect ratio even if resized to another
5178     * aspect ratio, there are two possibilities to resize it: keep the entire
5179     * image inside the limits of height and width of the object (@p fill_outside
5180     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5181     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5182     *
5183     * @note This option will have no effect if
5184     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5185     *
5186     * @see elm_image_fill_outside_get()
5187     * @see elm_image_aspect_ratio_retained_set()
5188     *
5189     * @ingroup Image
5190     */
5191    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5192    /**
5193     * Get if the object is filled outside
5194     *
5195     * @param obj The image object
5196     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5197     *
5198     * @see elm_image_fill_outside_set()
5199     *
5200     * @ingroup Image
5201     */
5202    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5203    /**
5204     * Set the prescale size for the image
5205     *
5206     * @param obj The image object
5207     * @param size The prescale size. This value is used for both width and
5208     * height.
5209     *
5210     * This function sets a new size for pixmap representation of the given
5211     * image. It allows the image to be loaded already in the specified size,
5212     * reducing the memory usage and load time when loading a big image with load
5213     * size set to a smaller size.
5214     *
5215     * It's equivalent to the elm_bg_load_size_set() function for bg.
5216     *
5217     * @note this is just a hint, the real size of the pixmap may differ
5218     * depending on the type of image being loaded, being bigger than requested.
5219     *
5220     * @see elm_image_prescale_get()
5221     * @see elm_bg_load_size_set()
5222     *
5223     * @ingroup Image
5224     */
5225    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5226    /**
5227     * Get the prescale size for the image
5228     *
5229     * @param obj The image object
5230     * @return The prescale size
5231     *
5232     * @see elm_image_prescale_set()
5233     *
5234     * @ingroup Image
5235     */
5236    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5237    /**
5238     * Set the image orientation.
5239     *
5240     * @param obj The image object
5241     * @param orient The image orientation @ref Elm_Image_Orient
5242     *  Default is #ELM_IMAGE_ORIENT_NONE.
5243     *
5244     * This function allows to rotate or flip the given image.
5245     *
5246     * @see elm_image_orient_get()
5247     * @see @ref Elm_Image_Orient
5248     *
5249     * @ingroup Image
5250     */
5251    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5252    /**
5253     * Get the image orientation.
5254     *
5255     * @param obj The image object
5256     * @return The image orientation @ref Elm_Image_Orient
5257     *
5258     * @see elm_image_orient_set()
5259     * @see @ref Elm_Image_Orient
5260     *
5261     * @ingroup Image
5262     */
5263    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5264    /**
5265     * Make the image 'editable'.
5266     *
5267     * @param obj Image object.
5268     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5269     *
5270     * This means the image is a valid drag target for drag and drop, and can be
5271     * cut or pasted too.
5272     *
5273     * @ingroup Image
5274     */
5275    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5276    /**
5277     * Check if the image 'editable'.
5278     *
5279     * @param obj Image object.
5280     * @return Editability.
5281     *
5282     * A return value of EINA_TRUE means the image is a valid drag target
5283     * for drag and drop, and can be cut or pasted too.
5284     *
5285     * @ingroup Image
5286     */
5287    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5288    /**
5289     * Get the basic Evas_Image object from this object (widget).
5290     *
5291     * @param obj The image object to get the inlined image from
5292     * @return The inlined image object, or NULL if none exists
5293     *
5294     * This function allows one to get the underlying @c Evas_Object of type
5295     * Image from this elementary widget. It can be useful to do things like get
5296     * the pixel data, save the image to a file, etc.
5297     *
5298     * @note Be careful to not manipulate it, as it is under control of
5299     * elementary.
5300     *
5301     * @ingroup Image
5302     */
5303    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5304    /**
5305     * Set whether the original aspect ratio of the image should be kept on resize.
5306     *
5307     * @param obj The image object.
5308     * @param retained @c EINA_TRUE if the image should retain the aspect,
5309     * @c EINA_FALSE otherwise.
5310     *
5311     * The original aspect ratio (width / height) of the image is usually
5312     * distorted to match the object's size. Enabling this option will retain
5313     * this original aspect, and the way that the image is fit into the object's
5314     * area depends on the option set by elm_image_fill_outside_set().
5315     *
5316     * @see elm_image_aspect_ratio_retained_get()
5317     * @see elm_image_fill_outside_set()
5318     *
5319     * @ingroup Image
5320     */
5321    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5322    /**
5323     * Get if the object retains the original aspect ratio.
5324     *
5325     * @param obj The image object.
5326     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5327     * otherwise.
5328     *
5329     * @ingroup Image
5330     */
5331    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5332
5333    /**
5334     * @}
5335     */
5336
5337    /**
5338     * @defgroup GLView
5339     *
5340     * A simple GLView widget that allows GL rendering.
5341     *
5342     * Signals that you can add callbacks for are:
5343     *
5344     * @{
5345     */
5346    typedef void (*Elm_GLView_Func)(Evas_Object *obj);
5347
5348    typedef enum _Elm_GLView_Mode
5349      {
5350         ELM_GLVIEW_ALPHA   = 1,
5351         ELM_GLVIEW_DEPTH   = 2,
5352         ELM_GLVIEW_STENCIL = 4
5353      } Elm_GLView_Mode;
5354
5355    typedef enum _Elm_GLView_Resize_Policy
5356      {
5357         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5358         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5359      } Elm_GLView_Resize_Policy;
5360
5361    typedef enum _Elm_GLView_Render_Policy
5362      {
5363         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5364         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5365      } Elm_GLView_Render_Policy;
5366
5367
5368    /**
5369     * Add a new glview to the parent
5370     *
5371     * @param parent The parent object
5372     * @return The new object or NULL if it cannot be created
5373     *
5374     * @ingroup GLView
5375     */
5376    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5377
5378    /**
5379     * Sets the size of the glview
5380     *
5381     * @param obj The glview object
5382     * @param width width of the glview object
5383     * @param height height of the glview object
5384     *
5385     * @ingroup GLView
5386     */
5387    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5388
5389    /**
5390     * Gets the size of the glview.
5391     *
5392     * @param obj The glview object
5393     * @param width width of the glview object
5394     * @param height height of the glview object
5395     *
5396     * Note that this function returns the actual image size of the
5397     * glview.  This means that when the scale policy is set to
5398     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5399     * size.
5400     *
5401     * @ingroup GLView
5402     */
5403    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5404
5405    /**
5406     * Gets the gl api struct for gl rendering
5407     *
5408     * @param obj The glview object
5409     * @return The api object or NULL if it cannot be created
5410     *
5411     * @ingroup GLView
5412     */
5413    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5414
5415    /**
5416     * Set the mode of the GLView. Supports Three simple modes.
5417     *
5418     * @param obj The glview object
5419     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5420     * @return True if set properly.
5421     *
5422     * @ingroup GLView
5423     */
5424    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5425
5426    /**
5427     * Set the resize policy for the glview object.
5428     *
5429     * @param obj The glview object.
5430     * @param policy The scaling policy.
5431     *
5432     * By default, the resize policy is set to
5433     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5434     * destroys the previous surface and recreates the newly specified
5435     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5436     * however, glview only scales the image object and not the underlying
5437     * GL Surface.
5438     *
5439     * @ingroup GLView
5440     */
5441    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5442
5443    /**
5444     * Set the render policy for the glview object.
5445     *
5446     * @param obj The glview object.
5447     * @param policy The render policy.
5448     *
5449     * By default, the render policy is set to
5450     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5451     * that during the render loop, glview is only redrawn if it needs
5452     * to be redrawn. (i.e. When it is visible) If the policy is set to
5453     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5454     * whether it is visible/need redrawing or not.
5455     *
5456     * @ingroup GLView
5457     */
5458    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5459
5460    /**
5461     * Set the init function that runs once in the main loop.
5462     *
5463     * @param obj The glview object.
5464     * @param func The init function to be registered.
5465     *
5466     * The registered init function gets called once during the render loop.
5467     *
5468     * @ingroup GLView
5469     */
5470    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
5471
5472    /**
5473     * Set the render function that runs in the main loop.
5474     *
5475     * @param obj The glview object.
5476     * @param func The delete function to be registered.
5477     *
5478     * The registered del function gets called when GLView object is deleted.
5479     *
5480     * @ingroup GLView
5481     */
5482    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
5483
5484    /**
5485     * Set the resize function that gets called when resize happens.
5486     *
5487     * @param obj The glview object.
5488     * @param func The resize function to be registered.
5489     *
5490     * @ingroup GLView
5491     */
5492    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
5493
5494    /**
5495     * Set the render function that runs in the main loop.
5496     *
5497     * @param obj The glview object.
5498     * @param func The render function to be registered.
5499     *
5500     * @ingroup GLView
5501     */
5502    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
5503
5504    /**
5505     * Notifies that there has been changes in the GLView.
5506     *
5507     * @param obj The glview object.
5508     *
5509     * @ingroup GLView
5510     */
5511    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5512
5513    /**
5514     * @}
5515     */
5516
5517    /* box */
5518    /**
5519     * @defgroup Box Box
5520     *
5521     * A box arranges objects in a linear fashion, governed by a layout function
5522     * that defines the details of this arrangement.
5523     *
5524     * By default, the box will use an internal function to set the layout to
5525     * a single row, either vertical or horizontal. This layout is affected
5526     * by a number of parameters, such as the homogeneous flag set by
5527     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5528     * elm_box_align_set() and the hints set to each object in the box.
5529     *
5530     * For this default layout, it's possible to change the orientation with
5531     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5532     * placing its elements ordered from top to bottom. When horizontal is set,
5533     * the order will go from left to right. If the box is set to be
5534     * homogeneous, every object in it will be assigned the same space, that
5535     * of the largest object. Padding can be used to set some spacing between
5536     * the cell given to each object. The alignment of the box, set with
5537     * elm_box_align_set(), determines how the bounding box of all the elements
5538     * will be placed within the space given to the box widget itself.
5539     *
5540     * The size hints of each object also affect how they are placed and sized
5541     * within the box. evas_object_size_hint_min_set() will give the minimum
5542     * size the object can have, and the box will use it as the basis for all
5543     * latter calculations. Elementary widgets set their own minimum size as
5544     * needed, so there's rarely any need to use it manually.
5545     *
5546     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5547     * used to tell whether the object will be allocated the minimum size it
5548     * needs or if the space given to it should be expanded. It's important
5549     * to realize that expanding the size given to the object is not the same
5550     * thing as resizing the object. It could very well end being a small
5551     * widget floating in a much larger empty space. If not set, the weight
5552     * for objects will normally be 0.0 for both axis, meaning the widget will
5553     * not be expanded. To take as much space possible, set the weight to
5554     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5555     *
5556     * Besides how much space each object is allocated, it's possible to control
5557     * how the widget will be placed within that space using
5558     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5559     * for both axis, meaning the object will be centered, but any value from
5560     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5561     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5562     * is -1.0, means the object will be resized to fill the entire space it
5563     * was allocated.
5564     *
5565     * In addition, customized functions to define the layout can be set, which
5566     * allow the application developer to organize the objects within the box
5567     * in any number of ways.
5568     *
5569     * The special elm_box_layout_transition() function can be used
5570     * to switch from one layout to another, animating the motion of the
5571     * children of the box.
5572     *
5573     * @note Objects should not be added to box objects using _add() calls.
5574     *
5575     * Some examples on how to use boxes follow:
5576     * @li @ref box_example_01
5577     * @li @ref box_example_02
5578     *
5579     * @{
5580     */
5581    /**
5582     * @typedef Elm_Box_Transition
5583     *
5584     * Opaque handler containing the parameters to perform an animated
5585     * transition of the layout the box uses.
5586     *
5587     * @see elm_box_transition_new()
5588     * @see elm_box_layout_set()
5589     * @see elm_box_layout_transition()
5590     */
5591    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5592
5593    /**
5594     * Add a new box to the parent
5595     *
5596     * By default, the box will be in vertical mode and non-homogeneous.
5597     *
5598     * @param parent The parent object
5599     * @return The new object or NULL if it cannot be created
5600     */
5601    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5602    /**
5603     * Set the horizontal orientation
5604     *
5605     * By default, box object arranges their contents vertically from top to
5606     * bottom.
5607     * By calling this function with @p horizontal as EINA_TRUE, the box will
5608     * become horizontal, arranging contents from left to right.
5609     *
5610     * @note This flag is ignored if a custom layout function is set.
5611     *
5612     * @param obj The box object
5613     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5614     * EINA_FALSE = vertical)
5615     */
5616    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5617    /**
5618     * Get the horizontal orientation
5619     *
5620     * @param obj The box object
5621     * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
5622     */
5623    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5624    /**
5625     * Set the box to arrange its children homogeneously
5626     *
5627     * If enabled, homogeneous layout makes all items the same size, according
5628     * to the size of the largest of its children.
5629     *
5630     * @note This flag is ignored if a custom layout function is set.
5631     *
5632     * @param obj The box object
5633     * @param homogeneous The homogeneous flag
5634     */
5635    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5636    /**
5637     * Get whether the box is using homogeneous mode or not
5638     *
5639     * @param obj The box object
5640     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5641     */
5642    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5643    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5644    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5645    /**
5646     * Add an object to the beginning of the pack list
5647     *
5648     * Pack @p subobj into the box @p obj, placing it first in the list of
5649     * children objects. The actual position the object will get on screen
5650     * depends on the layout used. If no custom layout is set, it will be at
5651     * the top or left, depending if the box is vertical or horizontal,
5652     * respectively.
5653     *
5654     * @param obj The box object
5655     * @param subobj The object to add to the box
5656     *
5657     * @see elm_box_pack_end()
5658     * @see elm_box_pack_before()
5659     * @see elm_box_pack_after()
5660     * @see elm_box_unpack()
5661     * @see elm_box_unpack_all()
5662     * @see elm_box_clear()
5663     */
5664    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5665    /**
5666     * Add an object at the end of the pack list
5667     *
5668     * Pack @p subobj into the box @p obj, placing it last in the list of
5669     * children objects. The actual position the object will get on screen
5670     * depends on the layout used. If no custom layout is set, it will be at
5671     * the bottom or right, depending if the box is vertical or horizontal,
5672     * respectively.
5673     *
5674     * @param obj The box object
5675     * @param subobj The object to add to the box
5676     *
5677     * @see elm_box_pack_start()
5678     * @see elm_box_pack_before()
5679     * @see elm_box_pack_after()
5680     * @see elm_box_unpack()
5681     * @see elm_box_unpack_all()
5682     * @see elm_box_clear()
5683     */
5684    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5685    /**
5686     * Adds an object to the box before the indicated object
5687     *
5688     * This will add the @p subobj to the box indicated before the object
5689     * indicated with @p before. If @p before is not already in the box, results
5690     * are undefined. Before means either to the left of the indicated object or
5691     * above it depending on orientation.
5692     *
5693     * @param obj The box object
5694     * @param subobj The object to add to the box
5695     * @param before The object before which to add it
5696     *
5697     * @see elm_box_pack_start()
5698     * @see elm_box_pack_end()
5699     * @see elm_box_pack_after()
5700     * @see elm_box_unpack()
5701     * @see elm_box_unpack_all()
5702     * @see elm_box_clear()
5703     */
5704    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5705    /**
5706     * Adds an object to the box after the indicated object
5707     *
5708     * This will add the @p subobj to the box indicated after the object
5709     * indicated with @p after. If @p after is not already in the box, results
5710     * are undefined. After means either to the right of the indicated object or
5711     * below it depending on orientation.
5712     *
5713     * @param obj The box object
5714     * @param subobj The object to add to the box
5715     * @param after The object after which to add it
5716     *
5717     * @see elm_box_pack_start()
5718     * @see elm_box_pack_end()
5719     * @see elm_box_pack_before()
5720     * @see elm_box_unpack()
5721     * @see elm_box_unpack_all()
5722     * @see elm_box_clear()
5723     */
5724    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5725    /**
5726     * Clear the box of all children
5727     *
5728     * Remove all the elements contained by the box, deleting the respective
5729     * objects.
5730     *
5731     * @param obj The box object
5732     *
5733     * @see elm_box_unpack()
5734     * @see elm_box_unpack_all()
5735     */
5736    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5737    /**
5738     * Unpack a box item
5739     *
5740     * Remove the object given by @p subobj from the box @p obj without
5741     * deleting it.
5742     *
5743     * @param obj The box object
5744     *
5745     * @see elm_box_unpack_all()
5746     * @see elm_box_clear()
5747     */
5748    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5749    /**
5750     * Remove all items from the box, without deleting them
5751     *
5752     * Clear the box from all children, but don't delete the respective objects.
5753     * If no other references of the box children exist, the objects will never
5754     * be deleted, and thus the application will leak the memory. Make sure
5755     * when using this function that you hold a reference to all the objects
5756     * in the box @p obj.
5757     *
5758     * @param obj The box object
5759     *
5760     * @see elm_box_clear()
5761     * @see elm_box_unpack()
5762     */
5763    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5764    /**
5765     * Retrieve a list of the objects packed into the box
5766     *
5767     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5768     * The order of the list corresponds to the packing order the box uses.
5769     *
5770     * You must free this list with eina_list_free() once you are done with it.
5771     *
5772     * @param obj The box object
5773     */
5774    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5775    /**
5776     * Set the space (padding) between the box's elements.
5777     *
5778     * Extra space in pixels that will be added between a box child and its
5779     * neighbors after its containing cell has been calculated. This padding
5780     * is set for all elements in the box, besides any possible padding that
5781     * individual elements may have through their size hints.
5782     *
5783     * @param obj The box object
5784     * @param horizontal The horizontal space between elements
5785     * @param vertical The vertical space between elements
5786     */
5787    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5788    /**
5789     * Get the space (padding) between the box's elements.
5790     *
5791     * @param obj The box object
5792     * @param horizontal The horizontal space between elements
5793     * @param vertical The vertical space between elements
5794     *
5795     * @see elm_box_padding_set()
5796     */
5797    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5798    /**
5799     * Set the alignment of the whole bouding box of contents.
5800     *
5801     * Sets how the bounding box containing all the elements of the box, after
5802     * their sizes and position has been calculated, will be aligned within
5803     * the space given for the whole box widget.
5804     *
5805     * @param obj The box object
5806     * @param horizontal The horizontal alignment of elements
5807     * @param vertical The vertical alignment of elements
5808     */
5809    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5810    /**
5811     * Get the alignment of the whole bouding box of contents.
5812     *
5813     * @param obj The box object
5814     * @param horizontal The horizontal alignment of elements
5815     * @param vertical The vertical alignment of elements
5816     *
5817     * @see elm_box_align_set()
5818     */
5819    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5820
5821    /**
5822     * Set the layout defining function to be used by the box
5823     *
5824     * Whenever anything changes that requires the box in @p obj to recalculate
5825     * the size and position of its elements, the function @p cb will be called
5826     * to determine what the layout of the children will be.
5827     *
5828     * Once a custom function is set, everything about the children layout
5829     * is defined by it. The flags set by elm_box_horizontal_set() and
5830     * elm_box_homogeneous_set() no longer have any meaning, and the values
5831     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5832     * layout function to decide if they are used and how. These last two
5833     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5834     * passed to @p cb. The @c Evas_Object the function receives is not the
5835     * Elementary widget, but the internal Evas Box it uses, so none of the
5836     * functions described here can be used on it.
5837     *
5838     * Any of the layout functions in @c Evas can be used here, as well as the
5839     * special elm_box_layout_transition().
5840     *
5841     * The final @p data argument received by @p cb is the same @p data passed
5842     * here, and the @p free_data function will be called to free it
5843     * whenever the box is destroyed or another layout function is set.
5844     *
5845     * Setting @p cb to NULL will revert back to the default layout function.
5846     *
5847     * @param obj The box object
5848     * @param cb The callback function used for layout
5849     * @param data Data that will be passed to layout function
5850     * @param free_data Function called to free @p data
5851     *
5852     * @see elm_box_layout_transition()
5853     */
5854    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);
5855    /**
5856     * Special layout function that animates the transition from one layout to another
5857     *
5858     * Normally, when switching the layout function for a box, this will be
5859     * reflected immediately on screen on the next render, but it's also
5860     * possible to do this through an animated transition.
5861     *
5862     * This is done by creating an ::Elm_Box_Transition and setting the box
5863     * layout to this function.
5864     *
5865     * For example:
5866     * @code
5867     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5868     *                            evas_object_box_layout_vertical, // start
5869     *                            NULL, // data for initial layout
5870     *                            NULL, // free function for initial data
5871     *                            evas_object_box_layout_horizontal, // end
5872     *                            NULL, // data for final layout
5873     *                            NULL, // free function for final data
5874     *                            anim_end, // will be called when animation ends
5875     *                            NULL); // data for anim_end function\
5876     * elm_box_layout_set(box, elm_box_layout_transition, t,
5877     *                    elm_box_transition_free);
5878     * @endcode
5879     *
5880     * @note This function can only be used with elm_box_layout_set(). Calling
5881     * it directly will not have the expected results.
5882     *
5883     * @see elm_box_transition_new
5884     * @see elm_box_transition_free
5885     * @see elm_box_layout_set
5886     */
5887    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5888    /**
5889     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5890     *
5891     * If you want to animate the change from one layout to another, you need
5892     * to set the layout function of the box to elm_box_layout_transition(),
5893     * passing as user data to it an instance of ::Elm_Box_Transition with the
5894     * necessary information to perform this animation. The free function to
5895     * set for the layout is elm_box_transition_free().
5896     *
5897     * The parameters to create an ::Elm_Box_Transition sum up to how long
5898     * will it be, in seconds, a layout function to describe the initial point,
5899     * another for the final position of the children and one function to be
5900     * called when the whole animation ends. This last function is useful to
5901     * set the definitive layout for the box, usually the same as the end
5902     * layout for the animation, but could be used to start another transition.
5903     *
5904     * @param start_layout The layout function that will be used to start the animation
5905     * @param start_layout_data The data to be passed the @p start_layout function
5906     * @param start_layout_free_data Function to free @p start_layout_data
5907     * @param end_layout The layout function that will be used to end the animation
5908     * @param end_layout_free_data The data to be passed the @p end_layout function
5909     * @param end_layout_free_data Function to free @p end_layout_data
5910     * @param transition_end_cb Callback function called when animation ends
5911     * @param transition_end_data Data to be passed to @p transition_end_cb
5912     * @return An instance of ::Elm_Box_Transition
5913     *
5914     * @see elm_box_transition_new
5915     * @see elm_box_layout_transition
5916     */
5917    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);
5918    /**
5919     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5920     *
5921     * This function is mostly useful as the @c free_data parameter in
5922     * elm_box_layout_set() when elm_box_layout_transition().
5923     *
5924     * @param data The Elm_Box_Transition instance to be freed.
5925     *
5926     * @see elm_box_transition_new
5927     * @see elm_box_layout_transition
5928     */
5929    EAPI void                elm_box_transition_free(void *data);
5930    /**
5931     * @}
5932     */
5933
5934    /* button */
5935    /**
5936     * @defgroup Button Button
5937     *
5938     * @image html  widget/button/preview-00.png
5939     * @image html  widget/button/preview-01.png
5940     * @image html  widget/button/preview-02.png
5941     *
5942     * This is a push-button. Press it and run some function. It can contain
5943     * a simple label and icon object and it also has an autorepeat feature.
5944     *
5945     * This widgets emits the following signals:
5946     * @li "clicked": the user clicked the button (press/release).
5947     * @li "repeated": the user pressed the button without releasing it.
5948     * @li "pressed": button was pressed.
5949     * @li "unpressed": button was released after being pressed.
5950     * In all three cases, the @c event parameter of the callback will be
5951     * @c NULL.
5952     *
5953     * Also, defined in the default theme, the button has the following styles
5954     * available:
5955     * @li default: a normal button.
5956     * @li anchor: Like default, but the button fades away when the mouse is not
5957     * over it, leaving only the text or icon.
5958     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5959     * continuous look across its options.
5960     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5961     *
5962     * Follow through a complete example @ref button_example_01 "here".
5963     * @{
5964     */
5965
5966    typedef enum
5967      {
5968         UIControlStateDefault,
5969         UIControlStateHighlighted,
5970         UIControlStateDisabled,
5971         UIControlStateFocused,
5972         UIControlStateReserved
5973      } UIControlState;
5974
5975    /**
5976     * Add a new button to the parent's canvas
5977     *
5978     * @param parent The parent object
5979     * @return The new object or NULL if it cannot be created
5980     */
5981    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5982    /**
5983     * Set the label used in the button
5984     *
5985     * The passed @p label can be NULL to clean any existing text in it and
5986     * leave the button as an icon only object.
5987     *
5988     * @param obj The button object
5989     * @param label The text will be written on the button
5990     * @deprecated use elm_object_text_set() instead.
5991     */
5992    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5993    /**
5994     * Get the label set for the button
5995     *
5996     * The string returned is an internal pointer and should not be freed or
5997     * altered. It will also become invalid when the button is destroyed.
5998     * The string returned, if not NULL, is a stringshare, so if you need to
5999     * keep it around even after the button is destroyed, you can use
6000     * eina_stringshare_ref().
6001     *
6002     * @param obj The button object
6003     * @return The text set to the label, or NULL if nothing is set
6004     * @deprecated use elm_object_text_set() instead.
6005     */
6006    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6007    /**
6008     * Set the label for each state of button
6009     *
6010     * The passed @p label can be NULL to clean any existing text in it and
6011     * leave the button as an icon only object for the state.
6012     *
6013     * @param obj The button object
6014     * @param label The text will be written on the button
6015     * @param state The state of button
6016     *
6017     * @ingroup Button
6018     */
6019    EINA_DEPRECATED EAPI void         elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6020    /**
6021     * Get the label of button for each state
6022     *
6023     * The string returned is an internal pointer and should not be freed or
6024     * altered. It will also become invalid when the button is destroyed.
6025     * The string returned, if not NULL, is a stringshare, so if you need to
6026     * keep it around even after the button is destroyed, you can use
6027     * eina_stringshare_ref().
6028     *
6029     * @param obj The button object
6030     * @param state The state of button
6031     * @return The title of button for state
6032     *
6033     * @ingroup Button
6034     */
6035    EINA_DEPRECATED EAPI const char  *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6036    /**
6037     * Set the icon used for the button
6038     *
6039     * Setting a new icon will delete any other that was previously set, making
6040     * any reference to them invalid. If you need to maintain the previous
6041     * object alive, unset it first with elm_button_icon_unset().
6042     *
6043     * @param obj The button object
6044     * @param icon The icon object for the button
6045     */
6046    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6047    /**
6048     * Get the icon used for the button
6049     *
6050     * Return the icon object which is set for this widget. If the button is
6051     * destroyed or another icon is set, the returned object will be deleted
6052     * and any reference to it will be invalid.
6053     *
6054     * @param obj The button object
6055     * @return The icon object that is being used
6056     *
6057     * @see elm_button_icon_unset()
6058     */
6059    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6060    /**
6061     * Remove the icon set without deleting it and return the object
6062     *
6063     * This function drops the reference the button holds of the icon object
6064     * and returns this last object. It is used in case you want to remove any
6065     * icon, or set another one, without deleting the actual object. The button
6066     * will be left without an icon set.
6067     *
6068     * @param obj The button object
6069     * @return The icon object that was being used
6070     */
6071    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6072    /**
6073     * Turn on/off the autorepeat event generated when the button is kept pressed
6074     *
6075     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6076     * signal when they are clicked.
6077     *
6078     * When on, keeping a button pressed will continuously emit a @c repeated
6079     * signal until the button is released. The time it takes until it starts
6080     * emitting the signal is given by
6081     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6082     * new emission by elm_button_autorepeat_gap_timeout_set().
6083     *
6084     * @param obj The button object
6085     * @param on  A bool to turn on/off the event
6086     */
6087    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6088    /**
6089     * Get whether the autorepeat feature is enabled
6090     *
6091     * @param obj The button object
6092     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6093     *
6094     * @see elm_button_autorepeat_set()
6095     */
6096    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6097    /**
6098     * Set the initial timeout before the autorepeat event is generated
6099     *
6100     * Sets the timeout, in seconds, since the button is pressed until the
6101     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6102     * won't be any delay and the even will be fired the moment the button is
6103     * pressed.
6104     *
6105     * @param obj The button object
6106     * @param t   Timeout in seconds
6107     *
6108     * @see elm_button_autorepeat_set()
6109     * @see elm_button_autorepeat_gap_timeout_set()
6110     */
6111    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6112    /**
6113     * Get the initial timeout before the autorepeat event is generated
6114     *
6115     * @param obj The button object
6116     * @return Timeout in seconds
6117     *
6118     * @see elm_button_autorepeat_initial_timeout_set()
6119     */
6120    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6121    /**
6122     * Set the interval between each generated autorepeat event
6123     *
6124     * After the first @c repeated event is fired, all subsequent ones will
6125     * follow after a delay of @p t seconds for each.
6126     *
6127     * @param obj The button object
6128     * @param t   Interval in seconds
6129     *
6130     * @see elm_button_autorepeat_initial_timeout_set()
6131     */
6132    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6133    /**
6134     * Get the interval between each generated autorepeat event
6135     *
6136     * @param obj The button object
6137     * @return Interval in seconds
6138     */
6139    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6140    /**
6141     * @}
6142     */
6143
6144    /**
6145     * @defgroup File_Selector_Button File Selector Button
6146     *
6147     * @image html img/widget/fileselector_button/preview-00.png
6148     * @image latex img/widget/fileselector_button/preview-00.eps
6149     * @image html img/widget/fileselector_button/preview-01.png
6150     * @image latex img/widget/fileselector_button/preview-01.eps
6151     * @image html img/widget/fileselector_button/preview-02.png
6152     * @image latex img/widget/fileselector_button/preview-02.eps
6153     *
6154     * This is a button that, when clicked, creates an Elementary
6155     * window (or inner window) <b> with a @ref Fileselector "file
6156     * selector widget" within</b>. When a file is chosen, the (inner)
6157     * window is closed and the button emits a signal having the
6158     * selected file as it's @c event_info.
6159     *
6160     * This widget encapsulates operations on its internal file
6161     * selector on its own API. There is less control over its file
6162     * selector than that one would have instatiating one directly.
6163     *
6164     * The following styles are available for this button:
6165     * @li @c "default"
6166     * @li @c "anchor"
6167     * @li @c "hoversel_vertical"
6168     * @li @c "hoversel_vertical_entry"
6169     *
6170     * Smart callbacks one can register to:
6171     * - @c "file,chosen" - the user has selected a path, whose string
6172     *   pointer comes as the @c event_info data (a stringshared
6173     *   string)
6174     *
6175     * Here is an example on its usage:
6176     * @li @ref fileselector_button_example
6177     *
6178     * @see @ref File_Selector_Entry for a similar widget.
6179     * @{
6180     */
6181
6182    /**
6183     * Add a new file selector button widget to the given parent
6184     * Elementary (container) object
6185     *
6186     * @param parent The parent object
6187     * @return a new file selector button widget handle or @c NULL, on
6188     * errors
6189     */
6190    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6191
6192    /**
6193     * Set the label for a given file selector button widget
6194     *
6195     * @param obj The file selector button widget
6196     * @param label The text label to be displayed on @p obj
6197     *
6198     * @deprecated use elm_object_text_set() instead.
6199     */
6200    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6201
6202    /**
6203     * Get the label set for a given file selector button widget
6204     *
6205     * @param obj The file selector button widget
6206     * @return The button label
6207     *
6208     * @deprecated use elm_object_text_set() instead.
6209     */
6210    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6211
6212    /**
6213     * Set the icon on a given file selector button widget
6214     *
6215     * @param obj The file selector button widget
6216     * @param icon The icon object for the button
6217     *
6218     * Once the icon object is set, a previously set one will be
6219     * deleted. If you want to keep the latter, use the
6220     * elm_fileselector_button_icon_unset() function.
6221     *
6222     * @see elm_fileselector_button_icon_get()
6223     */
6224    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6225
6226    /**
6227     * Get the icon set for a given file selector button widget
6228     *
6229     * @param obj The file selector button widget
6230     * @return The icon object currently set on @p obj or @c NULL, if
6231     * none is
6232     *
6233     * @see elm_fileselector_button_icon_set()
6234     */
6235    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6236
6237    /**
6238     * Unset the icon used in a given file selector button widget
6239     *
6240     * @param obj The file selector button widget
6241     * @return The icon object that was being used on @p obj or @c
6242     * NULL, on errors
6243     *
6244     * Unparent and return the icon object which was set for this
6245     * widget.
6246     *
6247     * @see elm_fileselector_button_icon_set()
6248     */
6249    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6250
6251    /**
6252     * Set the title for a given file selector button widget's window
6253     *
6254     * @param obj The file selector button widget
6255     * @param title The title string
6256     *
6257     * This will change the window's title, when the file selector pops
6258     * out after a click on the button. Those windows have the default
6259     * (unlocalized) value of @c "Select a file" as titles.
6260     *
6261     * @note It will only take any effect if the file selector
6262     * button widget is @b not under "inwin mode".
6263     *
6264     * @see elm_fileselector_button_window_title_get()
6265     */
6266    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6267
6268    /**
6269     * Get the title set for a given file selector button widget's
6270     * window
6271     *
6272     * @param obj The file selector button widget
6273     * @return Title of the file selector button's window
6274     *
6275     * @see elm_fileselector_button_window_title_get() for more details
6276     */
6277    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6278
6279    /**
6280     * Set the size of a given file selector button widget's window,
6281     * holding the file selector itself.
6282     *
6283     * @param obj The file selector button widget
6284     * @param width The window's width
6285     * @param height The window's height
6286     *
6287     * @note it will only take any effect if the file selector button
6288     * widget is @b not under "inwin mode". The default size for the
6289     * window (when applicable) is 400x400 pixels.
6290     *
6291     * @see elm_fileselector_button_window_size_get()
6292     */
6293    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6294
6295    /**
6296     * Get the size of a given file selector button widget's window,
6297     * holding the file selector itself.
6298     *
6299     * @param obj The file selector button widget
6300     * @param width Pointer into which to store the width value
6301     * @param height Pointer into which to store the height value
6302     *
6303     * @note Use @c NULL pointers on the size values you're not
6304     * interested in: they'll be ignored by the function.
6305     *
6306     * @see elm_fileselector_button_window_size_set(), for more details
6307     */
6308    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6309
6310    /**
6311     * Set the initial file system path for a given file selector
6312     * button widget
6313     *
6314     * @param obj The file selector button widget
6315     * @param path The path string
6316     *
6317     * It must be a <b>directory</b> path, which will have the contents
6318     * displayed initially in the file selector's view, when invoked
6319     * from @p obj. The default initial path is the @c "HOME"
6320     * environment variable's value.
6321     *
6322     * @see elm_fileselector_button_path_get()
6323     */
6324    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6325
6326    /**
6327     * Get the initial file system path set for a given file selector
6328     * button widget
6329     *
6330     * @param obj The file selector button widget
6331     * @return path The path string
6332     *
6333     * @see elm_fileselector_button_path_set() for more details
6334     */
6335    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6336
6337    /**
6338     * Enable/disable a tree view in the given file selector button
6339     * widget's internal file selector
6340     *
6341     * @param obj The file selector button widget
6342     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6343     * disable
6344     *
6345     * This has the same effect as elm_fileselector_expandable_set(),
6346     * but now applied to a file selector button's internal file
6347     * selector.
6348     *
6349     * @note There's no way to put a file selector button's internal
6350     * file selector in "grid mode", as one may do with "pure" file
6351     * selectors.
6352     *
6353     * @see elm_fileselector_expandable_get()
6354     */
6355    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6356
6357    /**
6358     * Get whether tree view is enabled for the given file selector
6359     * button widget's internal file selector
6360     *
6361     * @param obj The file selector button widget
6362     * @return @c EINA_TRUE if @p obj widget's internal file selector
6363     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6364     *
6365     * @see elm_fileselector_expandable_set() for more details
6366     */
6367    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6368
6369    /**
6370     * Set whether a given file selector button widget's internal file
6371     * selector is to display folders only or the directory contents,
6372     * as well.
6373     *
6374     * @param obj The file selector button widget
6375     * @param only @c EINA_TRUE to make @p obj widget's internal file
6376     * selector only display directories, @c EINA_FALSE to make files
6377     * to be displayed in it too
6378     *
6379     * This has the same effect as elm_fileselector_folder_only_set(),
6380     * but now applied to a file selector button's internal file
6381     * selector.
6382     *
6383     * @see elm_fileselector_folder_only_get()
6384     */
6385    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6386
6387    /**
6388     * Get whether a given file selector button widget's internal file
6389     * selector is displaying folders only or the directory contents,
6390     * as well.
6391     *
6392     * @param obj The file selector button widget
6393     * @return @c EINA_TRUE if @p obj widget's internal file
6394     * selector is only displaying directories, @c EINA_FALSE if files
6395     * are being displayed in it too (and on errors)
6396     *
6397     * @see elm_fileselector_button_folder_only_set() for more details
6398     */
6399    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6400
6401    /**
6402     * Enable/disable the file name entry box where the user can type
6403     * in a name for a file, in a given file selector button widget's
6404     * internal file selector.
6405     *
6406     * @param obj The file selector button widget
6407     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6408     * file selector a "saving dialog", @c EINA_FALSE otherwise
6409     *
6410     * This has the same effect as elm_fileselector_is_save_set(),
6411     * but now applied to a file selector button's internal file
6412     * selector.
6413     *
6414     * @see elm_fileselector_is_save_get()
6415     */
6416    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6417
6418    /**
6419     * Get whether the given file selector button widget's internal
6420     * file selector is in "saving dialog" mode
6421     *
6422     * @param obj The file selector button widget
6423     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6424     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6425     * errors)
6426     *
6427     * @see elm_fileselector_button_is_save_set() for more details
6428     */
6429    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6430
6431    /**
6432     * Set whether a given file selector button widget's internal file
6433     * selector will raise an Elementary "inner window", instead of a
6434     * dedicated Elementary window. By default, it won't.
6435     *
6436     * @param obj The file selector button widget
6437     * @param value @c EINA_TRUE to make it use an inner window, @c
6438     * EINA_TRUE to make it use a dedicated window
6439     *
6440     * @see elm_win_inwin_add() for more information on inner windows
6441     * @see elm_fileselector_button_inwin_mode_get()
6442     */
6443    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6444
6445    /**
6446     * Get whether a given file selector button widget's internal file
6447     * selector will raise an Elementary "inner window", instead of a
6448     * dedicated Elementary window.
6449     *
6450     * @param obj The file selector button widget
6451     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6452     * if it will use a dedicated window
6453     *
6454     * @see elm_fileselector_button_inwin_mode_set() for more details
6455     */
6456    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6457
6458    /**
6459     * @}
6460     */
6461
6462     /**
6463     * @defgroup File_Selector_Entry File Selector Entry
6464     *
6465     * @image html img/widget/fileselector_entry/preview-00.png
6466     * @image latex img/widget/fileselector_entry/preview-00.eps
6467     *
6468     * This is an entry made to be filled with or display a <b>file
6469     * system path string</b>. Besides the entry itself, the widget has
6470     * a @ref File_Selector_Button "file selector button" on its side,
6471     * which will raise an internal @ref Fileselector "file selector widget",
6472     * when clicked, for path selection aided by file system
6473     * navigation.
6474     *
6475     * This file selector may appear in an Elementary window or in an
6476     * inner window. When a file is chosen from it, the (inner) window
6477     * is closed and the selected file's path string is exposed both as
6478     * an smart event and as the new text on the entry.
6479     *
6480     * This widget encapsulates operations on its internal file
6481     * selector on its own API. There is less control over its file
6482     * selector than that one would have instatiating one directly.
6483     *
6484     * Smart callbacks one can register to:
6485     * - @c "changed" - The text within the entry was changed
6486     * - @c "activated" - The entry has had editing finished and
6487     *   changes are to be "committed"
6488     * - @c "press" - The entry has been clicked
6489     * - @c "longpressed" - The entry has been clicked (and held) for a
6490     *   couple seconds
6491     * - @c "clicked" - The entry has been clicked
6492     * - @c "clicked,double" - The entry has been double clicked
6493     * - @c "focused" - The entry has received focus
6494     * - @c "unfocused" - The entry has lost focus
6495     * - @c "selection,paste" - A paste action has occurred on the
6496     *   entry
6497     * - @c "selection,copy" - A copy action has occurred on the entry
6498     * - @c "selection,cut" - A cut action has occurred on the entry
6499     * - @c "unpressed" - The file selector entry's button was released
6500     *   after being pressed.
6501     * - @c "file,chosen" - The user has selected a path via the file
6502     *   selector entry's internal file selector, whose string pointer
6503     *   comes as the @c event_info data (a stringshared string)
6504     *
6505     * Here is an example on its usage:
6506     * @li @ref fileselector_entry_example
6507     *
6508     * @see @ref File_Selector_Button for a similar widget.
6509     * @{
6510     */
6511
6512    /**
6513     * Add a new file selector entry widget to the given parent
6514     * Elementary (container) object
6515     *
6516     * @param parent The parent object
6517     * @return a new file selector entry widget handle or @c NULL, on
6518     * errors
6519     */
6520    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6521
6522    /**
6523     * Set the label for a given file selector entry widget's button
6524     *
6525     * @param obj The file selector entry widget
6526     * @param label The text label to be displayed on @p obj widget's
6527     * button
6528     *
6529     * @deprecated use elm_object_text_set() instead.
6530     */
6531    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6532
6533    /**
6534     * Get the label set for a given file selector entry widget's button
6535     *
6536     * @param obj The file selector entry widget
6537     * @return The widget button's label
6538     *
6539     * @deprecated use elm_object_text_set() instead.
6540     */
6541    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6542
6543    /**
6544     * Set the icon on a given file selector entry widget's button
6545     *
6546     * @param obj The file selector entry widget
6547     * @param icon The icon object for the entry's button
6548     *
6549     * Once the icon object is set, a previously set one will be
6550     * deleted. If you want to keep the latter, use the
6551     * elm_fileselector_entry_button_icon_unset() function.
6552     *
6553     * @see elm_fileselector_entry_button_icon_get()
6554     */
6555    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6556
6557    /**
6558     * Get the icon set for a given file selector entry widget's button
6559     *
6560     * @param obj The file selector entry widget
6561     * @return The icon object currently set on @p obj widget's button
6562     * or @c NULL, if none is
6563     *
6564     * @see elm_fileselector_entry_button_icon_set()
6565     */
6566    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6567
6568    /**
6569     * Unset the icon used in a given file selector entry widget's
6570     * button
6571     *
6572     * @param obj The file selector entry widget
6573     * @return The icon object that was being used on @p obj widget's
6574     * button or @c NULL, on errors
6575     *
6576     * Unparent and return the icon object which was set for this
6577     * widget's button.
6578     *
6579     * @see elm_fileselector_entry_button_icon_set()
6580     */
6581    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6582
6583    /**
6584     * Set the title for a given file selector entry widget's window
6585     *
6586     * @param obj The file selector entry widget
6587     * @param title The title string
6588     *
6589     * This will change the window's title, when the file selector pops
6590     * out after a click on the entry's button. Those windows have the
6591     * default (unlocalized) value of @c "Select a file" as titles.
6592     *
6593     * @note It will only take any effect if the file selector
6594     * entry widget is @b not under "inwin mode".
6595     *
6596     * @see elm_fileselector_entry_window_title_get()
6597     */
6598    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6599
6600    /**
6601     * Get the title set for a given file selector entry widget's
6602     * window
6603     *
6604     * @param obj The file selector entry widget
6605     * @return Title of the file selector entry's window
6606     *
6607     * @see elm_fileselector_entry_window_title_get() for more details
6608     */
6609    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6610
6611    /**
6612     * Set the size of a given file selector entry widget's window,
6613     * holding the file selector itself.
6614     *
6615     * @param obj The file selector entry widget
6616     * @param width The window's width
6617     * @param height The window's height
6618     *
6619     * @note it will only take any effect if the file selector entry
6620     * widget is @b not under "inwin mode". The default size for the
6621     * window (when applicable) is 400x400 pixels.
6622     *
6623     * @see elm_fileselector_entry_window_size_get()
6624     */
6625    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6626
6627    /**
6628     * Get the size of a given file selector entry widget's window,
6629     * holding the file selector itself.
6630     *
6631     * @param obj The file selector entry widget
6632     * @param width Pointer into which to store the width value
6633     * @param height Pointer into which to store the height value
6634     *
6635     * @note Use @c NULL pointers on the size values you're not
6636     * interested in: they'll be ignored by the function.
6637     *
6638     * @see elm_fileselector_entry_window_size_set(), for more details
6639     */
6640    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6641
6642    /**
6643     * Set the initial file system path and the entry's path string for
6644     * a given file selector entry widget
6645     *
6646     * @param obj The file selector entry widget
6647     * @param path The path string
6648     *
6649     * It must be a <b>directory</b> path, which will have the contents
6650     * displayed initially in the file selector's view, when invoked
6651     * from @p obj. The default initial path is the @c "HOME"
6652     * environment variable's value.
6653     *
6654     * @see elm_fileselector_entry_path_get()
6655     */
6656    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6657
6658    /**
6659     * Get the entry's path string for a given file selector entry
6660     * widget
6661     *
6662     * @param obj The file selector entry widget
6663     * @return path The path string
6664     *
6665     * @see elm_fileselector_entry_path_set() for more details
6666     */
6667    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6668
6669    /**
6670     * Enable/disable a tree view in the given file selector entry
6671     * widget's internal file selector
6672     *
6673     * @param obj The file selector entry widget
6674     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6675     * disable
6676     *
6677     * This has the same effect as elm_fileselector_expandable_set(),
6678     * but now applied to a file selector entry's internal file
6679     * selector.
6680     *
6681     * @note There's no way to put a file selector entry's internal
6682     * file selector in "grid mode", as one may do with "pure" file
6683     * selectors.
6684     *
6685     * @see elm_fileselector_expandable_get()
6686     */
6687    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6688
6689    /**
6690     * Get whether tree view is enabled for the given file selector
6691     * entry widget's internal file selector
6692     *
6693     * @param obj The file selector entry widget
6694     * @return @c EINA_TRUE if @p obj widget's internal file selector
6695     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6696     *
6697     * @see elm_fileselector_expandable_set() for more details
6698     */
6699    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6700
6701    /**
6702     * Set whether a given file selector entry widget's internal file
6703     * selector is to display folders only or the directory contents,
6704     * as well.
6705     *
6706     * @param obj The file selector entry widget
6707     * @param only @c EINA_TRUE to make @p obj widget's internal file
6708     * selector only display directories, @c EINA_FALSE to make files
6709     * to be displayed in it too
6710     *
6711     * This has the same effect as elm_fileselector_folder_only_set(),
6712     * but now applied to a file selector entry's internal file
6713     * selector.
6714     *
6715     * @see elm_fileselector_folder_only_get()
6716     */
6717    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6718
6719    /**
6720     * Get whether a given file selector entry widget's internal file
6721     * selector is displaying folders only or the directory contents,
6722     * as well.
6723     *
6724     * @param obj The file selector entry widget
6725     * @return @c EINA_TRUE if @p obj widget's internal file
6726     * selector is only displaying directories, @c EINA_FALSE if files
6727     * are being displayed in it too (and on errors)
6728     *
6729     * @see elm_fileselector_entry_folder_only_set() for more details
6730     */
6731    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6732
6733    /**
6734     * Enable/disable the file name entry box where the user can type
6735     * in a name for a file, in a given file selector entry widget's
6736     * internal file selector.
6737     *
6738     * @param obj The file selector entry widget
6739     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6740     * file selector a "saving dialog", @c EINA_FALSE otherwise
6741     *
6742     * This has the same effect as elm_fileselector_is_save_set(),
6743     * but now applied to a file selector entry's internal file
6744     * selector.
6745     *
6746     * @see elm_fileselector_is_save_get()
6747     */
6748    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6749
6750    /**
6751     * Get whether the given file selector entry widget's internal
6752     * file selector is in "saving dialog" mode
6753     *
6754     * @param obj The file selector entry widget
6755     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6756     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6757     * errors)
6758     *
6759     * @see elm_fileselector_entry_is_save_set() for more details
6760     */
6761    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6762
6763    /**
6764     * Set whether a given file selector entry widget's internal file
6765     * selector will raise an Elementary "inner window", instead of a
6766     * dedicated Elementary window. By default, it won't.
6767     *
6768     * @param obj The file selector entry widget
6769     * @param value @c EINA_TRUE to make it use an inner window, @c
6770     * EINA_TRUE to make it use a dedicated window
6771     *
6772     * @see elm_win_inwin_add() for more information on inner windows
6773     * @see elm_fileselector_entry_inwin_mode_get()
6774     */
6775    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6776
6777    /**
6778     * Get whether a given file selector entry widget's internal file
6779     * selector will raise an Elementary "inner window", instead of a
6780     * dedicated Elementary window.
6781     *
6782     * @param obj The file selector entry widget
6783     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6784     * if it will use a dedicated window
6785     *
6786     * @see elm_fileselector_entry_inwin_mode_set() for more details
6787     */
6788    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6789
6790    /**
6791     * Set the initial file system path for a given file selector entry
6792     * widget
6793     *
6794     * @param obj The file selector entry widget
6795     * @param path The path string
6796     *
6797     * It must be a <b>directory</b> path, which will have the contents
6798     * displayed initially in the file selector's view, when invoked
6799     * from @p obj. The default initial path is the @c "HOME"
6800     * environment variable's value.
6801     *
6802     * @see elm_fileselector_entry_path_get()
6803     */
6804    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6805
6806    /**
6807     * Get the parent directory's path to the latest file selection on
6808     * a given filer selector entry widget
6809     *
6810     * @param obj The file selector object
6811     * @return The (full) path of the directory of the last selection
6812     * on @p obj widget, a @b stringshared string
6813     *
6814     * @see elm_fileselector_entry_path_set()
6815     */
6816    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6817
6818    /**
6819     * @}
6820     */
6821
6822    /**
6823     * @defgroup Scroller Scroller
6824     *
6825     * A scroller holds a single object and "scrolls it around". This means that
6826     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6827     * region around, allowing to move through a much larger object that is
6828     * contained in the scroller. The scroller will always have a small minimum
6829     * size by default as it won't be limited by the contents of the scroller.
6830     *
6831     * Signals that you can add callbacks for are:
6832     * @li "edge,left" - the left edge of the content has been reached
6833     * @li "edge,right" - the right edge of the content has been reached
6834     * @li "edge,top" - the top edge of the content has been reached
6835     * @li "edge,bottom" - the bottom edge of the content has been reached
6836     * @li "scroll" - the content has been scrolled (moved)
6837     * @li "scroll,anim,start" - scrolling animation has started
6838     * @li "scroll,anim,stop" - scrolling animation has stopped
6839     * @li "scroll,drag,start" - dragging the contents around has started
6840     * @li "scroll,drag,stop" - dragging the contents around has stopped
6841     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6842     * user intervetion.
6843     *
6844     * @note When Elemementary is in embedded mode the scrollbars will not be
6845     * dragable, they appear merely as indicators of how much has been scrolled.
6846     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6847     * fingerscroll) won't work.
6848     *
6849     * To set/get/unset the content of the panel, you can use
6850     * elm_object_content_set/get/unset APIs.
6851     * Once the content object is set, a previously set one will be deleted.
6852     * If you want to keep that old content object, use the
6853     * elm_object_content_unset() function
6854     *
6855     * In @ref tutorial_scroller you'll find an example of how to use most of
6856     * this API.
6857     * @{
6858     */
6859    /**
6860     * @brief Type that controls when scrollbars should appear.
6861     *
6862     * @see elm_scroller_policy_set()
6863     */
6864    typedef enum _Elm_Scroller_Policy
6865      {
6866         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6867         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6868         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6869         ELM_SCROLLER_POLICY_LAST
6870      } Elm_Scroller_Policy;
6871    /**
6872     * @brief Add a new scroller to the parent
6873     *
6874     * @param parent The parent object
6875     * @return The new object or NULL if it cannot be created
6876     */
6877    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6878    /**
6879     * @brief Set the content of the scroller widget (the object to be scrolled around).
6880     *
6881     * @param obj The scroller object
6882     * @param content The new content object
6883     *
6884     * Once the content object is set, a previously set one will be deleted.
6885     * If you want to keep that old content object, use the
6886     * elm_scroller_content_unset() function.
6887     * @deprecated See elm_object_content_set()
6888     */
6889    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6890    /**
6891     * @brief Get the content of the scroller widget
6892     *
6893     * @param obj The slider object
6894     * @return The content that is being used
6895     *
6896     * Return the content object which is set for this widget
6897     *
6898     * @see elm_scroller_content_set()
6899     * @deprecated use elm_object_content_get() instead.
6900     */
6901    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6902    /**
6903     * @brief Unset the content of the scroller widget
6904     *
6905     * @param obj The slider object
6906     * @return The content that was being used
6907     *
6908     * Unparent and return the content object which was set for this widget
6909     *
6910     * @see elm_scroller_content_set()
6911     * @deprecated use elm_object_content_unset() instead.
6912     */
6913    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6914    /**
6915     * @brief Set custom theme elements for the scroller
6916     *
6917     * @param obj The scroller object
6918     * @param widget The widget name to use (default is "scroller")
6919     * @param base The base name to use (default is "base")
6920     */
6921    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6922    /**
6923     * @brief Make the scroller minimum size limited to the minimum size of the content
6924     *
6925     * @param obj The scroller object
6926     * @param w Enable limiting minimum size horizontally
6927     * @param h Enable limiting minimum size vertically
6928     *
6929     * By default the scroller will be as small as its design allows,
6930     * irrespective of its content. This will make the scroller minimum size the
6931     * right size horizontally and/or vertically to perfectly fit its content in
6932     * that direction.
6933     */
6934    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6935    /**
6936     * @brief Show a specific virtual region within the scroller content object
6937     *
6938     * @param obj The scroller object
6939     * @param x X coordinate of the region
6940     * @param y Y coordinate of the region
6941     * @param w Width of the region
6942     * @param h Height of the region
6943     *
6944     * This will ensure all (or part if it does not fit) of the designated
6945     * region in the virtual content object (0, 0 starting at the top-left of the
6946     * virtual content object) is shown within the scroller.
6947     */
6948    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);
6949    /**
6950     * @brief Set the scrollbar visibility policy
6951     *
6952     * @param obj The scroller object
6953     * @param policy_h Horizontal scrollbar policy
6954     * @param policy_v Vertical scrollbar policy
6955     *
6956     * This sets the scrollbar visibility policy for the given scroller.
6957     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6958     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6959     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6960     * respectively for the horizontal and vertical scrollbars.
6961     */
6962    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6963    /**
6964     * @brief Gets scrollbar visibility policy
6965     *
6966     * @param obj The scroller object
6967     * @param policy_h Horizontal scrollbar policy
6968     * @param policy_v Vertical scrollbar policy
6969     *
6970     * @see elm_scroller_policy_set()
6971     */
6972    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6973    /**
6974     * @brief Get the currently visible content region
6975     *
6976     * @param obj The scroller object
6977     * @param x X coordinate of the region
6978     * @param y Y coordinate of the region
6979     * @param w Width of the region
6980     * @param h Height of the region
6981     *
6982     * This gets the current region in the content object that is visible through
6983     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6984     * w, @p h values pointed to.
6985     *
6986     * @note All coordinates are relative to the content.
6987     *
6988     * @see elm_scroller_region_show()
6989     */
6990    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);
6991    /**
6992     * @brief Get the size of the content object
6993     *
6994     * @param obj The scroller object
6995     * @param w Width of the content object.
6996     * @param h Height of the content object.
6997     *
6998     * This gets the size of the content object of the scroller.
6999     */
7000    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7001    /**
7002     * @brief Set bouncing behavior
7003     *
7004     * @param obj The scroller object
7005     * @param h_bounce Allow bounce horizontally
7006     * @param v_bounce Allow bounce vertically
7007     *
7008     * When scrolling, the scroller may "bounce" when reaching an edge of the
7009     * content object. This is a visual way to indicate the end has been reached.
7010     * This is enabled by default for both axis. This API will set if it is enabled
7011     * for the given axis with the boolean parameters for each axis.
7012     */
7013    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7014    /**
7015     * @brief Get the bounce behaviour
7016     *
7017     * @param obj The Scroller object
7018     * @param h_bounce Will the scroller bounce horizontally or not
7019     * @param v_bounce Will the scroller bounce vertically or not
7020     *
7021     * @see elm_scroller_bounce_set()
7022     */
7023    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7024    /**
7025     * @brief Set scroll page size relative to viewport size.
7026     *
7027     * @param obj The scroller object
7028     * @param h_pagerel The horizontal page relative size
7029     * @param v_pagerel The vertical page relative size
7030     *
7031     * The scroller is capable of limiting scrolling by the user to "pages". That
7032     * is to jump by and only show a "whole page" at a time as if the continuous
7033     * area of the scroller content is split into page sized pieces. This sets
7034     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7035     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7036     * axis. This is mutually exclusive with page size
7037     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7038     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7039     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7040     * the other axis.
7041     */
7042    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7043    /**
7044     * @brief Set scroll page size.
7045     *
7046     * @param obj The scroller object
7047     * @param h_pagesize The horizontal page size
7048     * @param v_pagesize The vertical page size
7049     *
7050     * This sets the page size to an absolute fixed value, with 0 turning it off
7051     * for that axis.
7052     *
7053     * @see elm_scroller_page_relative_set()
7054     */
7055    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7056    /**
7057     * @brief Show a specific virtual region within the scroller content object.
7058     *
7059     * @param obj The scroller object
7060     * @param x X coordinate of the region
7061     * @param y Y coordinate of the region
7062     * @param w Width of the region
7063     * @param h Height of the region
7064     *
7065     * This will ensure all (or part if it does not fit) of the designated
7066     * region in the virtual content object (0, 0 starting at the top-left of the
7067     * virtual content object) is shown within the scroller. Unlike
7068     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7069     * to this location (if configuration in general calls for transitions). It
7070     * may not jump immediately to the new location and make take a while and
7071     * show other content along the way.
7072     *
7073     * @see elm_scroller_region_show()
7074     */
7075    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);
7076    /**
7077     * @brief Set event propagation on a scroller
7078     *
7079     * @param obj The scroller object
7080     * @param propagation If propagation is enabled or not
7081     *
7082     * This enables or disabled event propagation from the scroller content to
7083     * the scroller and its parent. By default event propagation is disabled.
7084     */
7085    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7086    /**
7087     * @brief Get event propagation for a scroller
7088     *
7089     * @param obj The scroller object
7090     * @return The propagation state
7091     *
7092     * This gets the event propagation for a scroller.
7093     *
7094     * @see elm_scroller_propagate_events_set()
7095     */
7096    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7097    /**
7098     * @brief Set scrolling gravity on a scroller
7099     *
7100     * @param obj The scroller object
7101     * @param x The scrolling horizontal gravity
7102     * @param y The scrolling vertical gravity
7103     *
7104     * The gravity, defines how the scroller will adjust its view
7105     * when the size of the scroller contents increase.
7106     *
7107     * The scroller will adjust the view to glue itself as follows.
7108     *
7109     *  x=0.0, for showing the left most region of the content.
7110     *  x=1.0, for showing the right most region of the content.
7111     *  y=0.0, for showing the bottom most region of the content.
7112     *  y=1.0, for showing the top most region of the content.
7113     *
7114     * Default values for x and y are 0.0
7115     */
7116    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7117    /**
7118     * @brief Get scrolling gravity values for a scroller
7119     *
7120     * @param obj The scroller object
7121     * @param x The scrolling horizontal gravity
7122     * @param y The scrolling vertical gravity
7123     *
7124     * This gets gravity values for a scroller.
7125     *
7126     * @see elm_scroller_gravity_set()
7127     *
7128     */
7129    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7130    /**
7131     * @}
7132     */
7133
7134    /**
7135     * @defgroup Label Label
7136     *
7137     * @image html img/widget/label/preview-00.png
7138     * @image latex img/widget/label/preview-00.eps
7139     *
7140     * @brief Widget to display text, with simple html-like markup.
7141     *
7142     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7143     * text doesn't fit the geometry of the label it will be ellipsized or be
7144     * cut. Elementary provides several themes for this widget:
7145     * @li default - No animation
7146     * @li marker - Centers the text in the label and make it bold by default
7147     * @li slide_long - The entire text appears from the right of the screen and
7148     * slides until it disappears in the left of the screen(reappering on the
7149     * right again).
7150     * @li slide_short - The text appears in the left of the label and slides to
7151     * the right to show the overflow. When all of the text has been shown the
7152     * position is reset.
7153     * @li slide_bounce - The text appears in the left of the label and slides to
7154     * the right to show the overflow. When all of the text has been shown the
7155     * animation reverses, moving the text to the left.
7156     *
7157     * Custom themes can of course invent new markup tags and style them any way
7158     * they like.
7159     *
7160     * The following signals may be emitted by the label widget:
7161     * @li "language,changed": The program's language changed.
7162     *
7163     * See @ref tutorial_label for a demonstration of how to use a label widget.
7164     * @{
7165     */
7166    /**
7167     * @brief Add a new label to the parent
7168     *
7169     * @param parent The parent object
7170     * @return The new object or NULL if it cannot be created
7171     */
7172    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7173    /**
7174     * @brief Set the label on the label object
7175     *
7176     * @param obj The label object
7177     * @param label The label will be used on the label object
7178     * @deprecated See elm_object_text_set()
7179     */
7180    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 */
7181    /**
7182     * @brief Get the label used on the label object
7183     *
7184     * @param obj The label object
7185     * @return The string inside the label
7186     * @deprecated See elm_object_text_get()
7187     */
7188    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7189    /**
7190     * @brief Set the wrapping behavior of the label
7191     *
7192     * @param obj The label object
7193     * @param wrap To wrap text or not
7194     *
7195     * By default no wrapping is done. Possible values for @p wrap are:
7196     * @li ELM_WRAP_NONE - No wrapping
7197     * @li ELM_WRAP_CHAR - wrap between characters
7198     * @li ELM_WRAP_WORD - wrap between words
7199     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7200     */
7201    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7202    /**
7203     * @brief Get the wrapping behavior of the label
7204     *
7205     * @param obj The label object
7206     * @return Wrap type
7207     *
7208     * @see elm_label_line_wrap_set()
7209     */
7210    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7211    /**
7212     * @brief Set wrap width of the label
7213     *
7214     * @param obj The label object
7215     * @param w The wrap width in pixels at a minimum where words need to wrap
7216     *
7217     * This function sets the maximum width size hint of the label.
7218     *
7219     * @warning This is only relevant if the label is inside a container.
7220     */
7221    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7222    /**
7223     * @brief Get wrap width of the label
7224     *
7225     * @param obj The label object
7226     * @return The wrap width in pixels at a minimum where words need to wrap
7227     *
7228     * @see elm_label_wrap_width_set()
7229     */
7230    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7231    /**
7232     * @brief Set wrap height of the label
7233     *
7234     * @param obj The label object
7235     * @param h The wrap height in pixels at a minimum where words need to wrap
7236     *
7237     * This function sets the maximum height size hint of the label.
7238     *
7239     * @warning This is only relevant if the label is inside a container.
7240     */
7241    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7242    /**
7243     * @brief get wrap width of the label
7244     *
7245     * @param obj The label object
7246     * @return The wrap height in pixels at a minimum where words need to wrap
7247     */
7248    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7249    /**
7250     * @brief Set the font size on the label object.
7251     *
7252     * @param obj The label object
7253     * @param size font size
7254     *
7255     * @warning NEVER use this. It is for hyper-special cases only. use styles
7256     * instead. e.g. "big", "medium", "small" - or better name them by use:
7257     * "title", "footnote", "quote" etc.
7258     */
7259    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7260    /**
7261     * @brief Set the text color on the label object
7262     *
7263     * @param obj The label object
7264     * @param r Red property background color of The label object
7265     * @param g Green property background color of The label object
7266     * @param b Blue property background color of The label object
7267     * @param a Alpha property background color of The label object
7268     *
7269     * @warning NEVER use this. It is for hyper-special cases only. use styles
7270     * instead. e.g. "big", "medium", "small" - or better name them by use:
7271     * "title", "footnote", "quote" etc.
7272     */
7273    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);
7274    /**
7275     * @brief Set the text align on the label object
7276     *
7277     * @param obj The label object
7278     * @param align align mode ("left", "center", "right")
7279     *
7280     * @warning NEVER use this. It is for hyper-special cases only. use styles
7281     * instead. e.g. "big", "medium", "small" - or better name them by use:
7282     * "title", "footnote", "quote" etc.
7283     */
7284    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7285    /**
7286     * @brief Set background color of the label
7287     *
7288     * @param obj The label object
7289     * @param r Red property background color of The label object
7290     * @param g Green property background color of The label object
7291     * @param b Blue property background color of The label object
7292     * @param a Alpha property background alpha of The label object
7293     *
7294     * @warning NEVER use this. It is for hyper-special cases only. use styles
7295     * instead. e.g. "big", "medium", "small" - or better name them by use:
7296     * "title", "footnote", "quote" etc.
7297     */
7298    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);
7299    /**
7300     * @brief Set the ellipsis behavior of the label
7301     *
7302     * @param obj The label object
7303     * @param ellipsis To ellipsis text or not
7304     *
7305     * If set to true and the text doesn't fit in the label an ellipsis("...")
7306     * will be shown at the end of the widget.
7307     *
7308     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7309     * choosen wrap method was ELM_WRAP_WORD.
7310     */
7311    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7312    EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7313    /**
7314     * @brief Set the text slide of the label
7315     *
7316     * @param obj The label object
7317     * @param slide To start slide or stop
7318     *
7319     * If set to true, the text of the label will slide/scroll through the length of
7320     * label.
7321     *
7322     * @warning This only works with the themes "slide_short", "slide_long" and
7323     * "slide_bounce".
7324     */
7325    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7326    /**
7327     * @brief Get the text slide mode of the label
7328     *
7329     * @param obj The label object
7330     * @return slide slide mode value
7331     *
7332     * @see elm_label_slide_set()
7333     */
7334    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7335    /**
7336     * @brief Set the slide duration(speed) of the label
7337     *
7338     * @param obj The label object
7339     * @return The duration in seconds in moving text from slide begin position
7340     * to slide end position
7341     */
7342    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7343    /**
7344     * @brief Get the slide duration(speed) of the label
7345     *
7346     * @param obj The label object
7347     * @return The duration time in moving text from slide begin position to slide end position
7348     *
7349     * @see elm_label_slide_duration_set()
7350     */
7351    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7352    /**
7353     * @}
7354     */
7355
7356    /**
7357     * @defgroup Toggle Toggle
7358     *
7359     * @image html img/widget/toggle/preview-00.png
7360     * @image latex img/widget/toggle/preview-00.eps
7361     *
7362     * @brief A toggle is a slider which can be used to toggle between
7363     * two values.  It has two states: on and off.
7364     *
7365     * This widget is deprecated. Please use elm_check_add() instead using the
7366     * toggle style like:
7367     * 
7368     * @code
7369     * obj = elm_check_add(parent);
7370     * elm_object_style_set(obj, "toggle");
7371     * elm_object_text_part_set(obj, "on", "ON");
7372     * elm_object_text_part_set(obj, "off", "OFF");
7373     * @endcode
7374     * 
7375     * Signals that you can add callbacks for are:
7376     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7377     *                 until the toggle is released by the cursor (assuming it
7378     *                 has been triggered by the cursor in the first place).
7379     *
7380     * @ref tutorial_toggle show how to use a toggle.
7381     * @{
7382     */
7383    /**
7384     * @brief Add a toggle to @p parent.
7385     *
7386     * @param parent The parent object
7387     *
7388     * @return The toggle object
7389     */
7390    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7391    /**
7392     * @brief Sets the label to be displayed with the toggle.
7393     *
7394     * @param obj The toggle object
7395     * @param label The label to be displayed
7396     *
7397     * @deprecated use elm_object_text_set() instead.
7398     */
7399    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7400    /**
7401     * @brief Gets the label of the toggle
7402     *
7403     * @param obj  toggle object
7404     * @return The label of the toggle
7405     *
7406     * @deprecated use elm_object_text_get() instead.
7407     */
7408    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7409    /**
7410     * @brief Set the icon used for the toggle
7411     *
7412     * @param obj The toggle object
7413     * @param icon The icon object for the button
7414     *
7415     * Once the icon object is set, a previously set one will be deleted
7416     * If you want to keep that old content object, use the
7417     * elm_toggle_icon_unset() function.
7418     *
7419     * @deprecated use elm_object_content_set() instead.
7420     */
7421    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7422    /**
7423     * @brief Get the icon used for the toggle
7424     *
7425     * @param obj The toggle object
7426     * @return The icon object that is being used
7427     *
7428     * Return the icon object which is set for this widget.
7429     *
7430     * @see elm_toggle_icon_set()
7431     *
7432     * @deprecated use elm_object_content_get() instead.
7433     */
7434    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7435    /**
7436     * @brief Unset the icon used for the toggle
7437     *
7438     * @param obj The toggle object
7439     * @return The icon object that was being used
7440     *
7441     * Unparent and return the icon object which was set for this widget.
7442     *
7443     * @see elm_toggle_icon_set()
7444     *
7445     * @deprecated use elm_object_content_unset() instead.
7446     */
7447    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7448    /**
7449     * @brief Sets the labels to be associated with the on and off states of the toggle.
7450     *
7451     * @param obj The toggle object
7452     * @param onlabel The label displayed when the toggle is in the "on" state
7453     * @param offlabel The label displayed when the toggle is in the "off" state
7454     *
7455     * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7456     * instead.
7457     */
7458    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7459    /**
7460     * @brief Gets the labels associated with the on and off states of the
7461     * toggle.
7462     *
7463     * @param obj The toggle object
7464     * @param onlabel A char** to place the onlabel of @p obj into
7465     * @param offlabel A char** to place the offlabel of @p obj into
7466     *
7467     * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7468     * instead.
7469     */
7470    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7471    /**
7472     * @brief Sets the state of the toggle to @p state.
7473     *
7474     * @param obj The toggle object
7475     * @param state The state of @p obj
7476     *
7477     * @deprecated use elm_check_state_set() instead.
7478     */
7479    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7480    /**
7481     * @brief Gets the state of the toggle to @p state.
7482     *
7483     * @param obj The toggle object
7484     * @return The state of @p obj
7485     *
7486     * @deprecated use elm_check_state_get() instead.
7487     */
7488    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7489    /**
7490     * @brief Sets the state pointer of the toggle to @p statep.
7491     *
7492     * @param obj The toggle object
7493     * @param statep The state pointer of @p obj
7494     *
7495     * @deprecated use elm_check_state_pointer_set() instead.
7496     */
7497    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7498    /**
7499     * @}
7500     */
7501
7502    /**
7503     * @page tutorial_frame Frame example
7504     * @dontinclude frame_example_01.c
7505     *
7506     * In this example we are going to create 4 Frames with different styles and
7507     * add a rectangle of different color in each.
7508     *
7509     * We start we the usual setup code:
7510     * @until show(bg)
7511     *
7512     * And then create one rectangle:
7513     * @until show
7514     *
7515     * To add it in our first frame, which since it doesn't have it's style
7516     * specifically set uses the default style:
7517     * @until show
7518     *
7519     * And then create another rectangle:
7520     * @until show
7521     *
7522     * To add it in our second frame, which uses the "pad_small" style, note that
7523     * even tough we are setting a text for this frame it won't be show, only the
7524     * default style shows the Frame's title:
7525     * @until show
7526     * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
7527     * very similar, their only difference is the size of the empty area around
7528     * the content of the frame.
7529     *
7530     * And then create yet another rectangle:
7531     * @until show
7532     *
7533     * To add it in our third frame, which uses the "outdent_top" style, note
7534     * that even tough we are setting a text for this frame it won't be show,
7535     * only the default style shows the Frame's title:
7536     * @until show
7537     *
7538     * And then create one last rectangle:
7539     * @until show
7540     *
7541     * To add it in our fourth and final frame, which uses the "outdent_bottom"
7542     * style, note that even tough we are setting a text for this frame it won't
7543     * be show, only the default style shows the Frame's title:
7544     * @until show
7545     *
7546     * And now we are left with just some more setup code:
7547     * @until ELM_MAIN()
7548     *
7549     * Our example will look like this:
7550     * @image html screenshots/frame_example_01.png
7551     * @image latex screenshots/frame_example_01.eps
7552     *
7553     * @example frame_example_01.c
7554     */
7555    /**
7556     * @defgroup Frame Frame
7557     *
7558     * @brief Frame is a widget that holds some content and has a title.
7559     *
7560     * The default look is a frame with a title, but Frame supports multple
7561     * styles:
7562     * @li default
7563     * @li pad_small
7564     * @li pad_medium
7565     * @li pad_large
7566     * @li pad_huge
7567     * @li outdent_top
7568     * @li outdent_bottom
7569     *
7570     * Of all this styles only default shows the title. Frame emits no signals.
7571     *
7572     * For a detailed example see the @ref tutorial_frame.
7573     *
7574     * @{
7575     */
7576    /**
7577     * @brief Add a new frame to the parent
7578     *
7579     * @param parent The parent object
7580     * @return The new object or NULL if it cannot be created
7581     */
7582    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7583    /**
7584     * @brief Set the frame label
7585     *
7586     * @param obj The frame object
7587     * @param label The label of this frame object
7588     *
7589     * @deprecated use elm_object_text_set() instead.
7590     */
7591    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7592    /**
7593     * @brief Get the frame label
7594     *
7595     * @param obj The frame object
7596     *
7597     * @return The label of this frame objet or NULL if unable to get frame
7598     *
7599     * @deprecated use elm_object_text_get() instead.
7600     */
7601    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7602    /**
7603     * @brief Set the content of the frame widget
7604     *
7605     * Once the content object is set, a previously set one will be deleted.
7606     * If you want to keep that old content object, use the
7607     * elm_frame_content_unset() function.
7608     *
7609     * @param obj The frame object
7610     * @param content The content will be filled in this frame object
7611     */
7612    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7613    /**
7614     * @brief Get the content of the frame widget
7615     *
7616     * Return the content object which is set for this widget
7617     *
7618     * @param obj The frame object
7619     * @return The content that is being used
7620     */
7621    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7622    /**
7623     * @brief Unset the content of the frame widget
7624     *
7625     * Unparent and return the content object which was set for this widget
7626     *
7627     * @param obj The frame object
7628     * @return The content that was being used
7629     */
7630    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7631    /**
7632     * @}
7633     */
7634
7635    /**
7636     * @defgroup Table Table
7637     *
7638     * A container widget to arrange other widgets in a table where items can
7639     * also span multiple columns or rows - even overlap (and then be raised or
7640     * lowered accordingly to adjust stacking if they do overlap).
7641     *
7642     * For a Table widget the row/column count is not fixed.
7643     * The table widget adjusts itself when subobjects are added to it dynamically.
7644     *
7645     * The followin are examples of how to use a table:
7646     * @li @ref tutorial_table_01
7647     * @li @ref tutorial_table_02
7648     *
7649     * @{
7650     */
7651    /**
7652     * @brief Add a new table to the parent
7653     *
7654     * @param parent The parent object
7655     * @return The new object or NULL if it cannot be created
7656     */
7657    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7658    /**
7659     * @brief Set the homogeneous layout in the table
7660     *
7661     * @param obj The layout object
7662     * @param homogeneous A boolean to set if the layout is homogeneous in the
7663     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7664     */
7665    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7666    /**
7667     * @brief Get the current table homogeneous mode.
7668     *
7669     * @param obj The table object
7670     * @return A boolean to indicating if the layout is homogeneous in the table
7671     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7672     */
7673    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7674    /**
7675     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7676     */
7677    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7678    /**
7679     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7680     */
7681    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7682    /**
7683     * @brief Set padding between cells.
7684     *
7685     * @param obj The layout object.
7686     * @param horizontal set the horizontal padding.
7687     * @param vertical set the vertical padding.
7688     *
7689     * Default value is 0.
7690     */
7691    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7692    /**
7693     * @brief Get padding between cells.
7694     *
7695     * @param obj The layout object.
7696     * @param horizontal set the horizontal padding.
7697     * @param vertical set the vertical padding.
7698     */
7699    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7700    /**
7701     * @brief Add a subobject on the table with the coordinates passed
7702     *
7703     * @param obj The table object
7704     * @param subobj The subobject to be added to the table
7705     * @param x Row number
7706     * @param y Column number
7707     * @param w rowspan
7708     * @param h colspan
7709     *
7710     * @note All positioning inside the table is relative to rows and columns, so
7711     * a value of 0 for x and y, means the top left cell of the table, and a
7712     * value of 1 for w and h means @p subobj only takes that 1 cell.
7713     */
7714    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7715    /**
7716     * @brief Remove child from table.
7717     *
7718     * @param obj The table object
7719     * @param subobj The subobject
7720     */
7721    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7722    /**
7723     * @brief Faster way to remove all child objects from a table object.
7724     *
7725     * @param obj The table object
7726     * @param clear If true, will delete children, else just remove from table.
7727     */
7728    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7729    /**
7730     * @brief Set the packing location of an existing child of the table
7731     *
7732     * @param subobj The subobject to be modified in the table
7733     * @param x Row number
7734     * @param y Column number
7735     * @param w rowspan
7736     * @param h colspan
7737     *
7738     * Modifies the position of an object already in the table.
7739     *
7740     * @note All positioning inside the table is relative to rows and columns, so
7741     * a value of 0 for x and y, means the top left cell of the table, and a
7742     * value of 1 for w and h means @p subobj only takes that 1 cell.
7743     */
7744    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7745    /**
7746     * @brief Get the packing location of an existing child of the table
7747     *
7748     * @param subobj The subobject to be modified in the table
7749     * @param x Row number
7750     * @param y Column number
7751     * @param w rowspan
7752     * @param h colspan
7753     *
7754     * @see elm_table_pack_set()
7755     */
7756    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7757    /**
7758     * @}
7759     */
7760
7761    /**
7762     * @defgroup Gengrid Gengrid (Generic grid)
7763     *
7764     * This widget aims to position objects in a grid layout while
7765     * actually creating and rendering only the visible ones, using the
7766     * same idea as the @ref Genlist "genlist": the user defines a @b
7767     * class for each item, specifying functions that will be called at
7768     * object creation, deletion, etc. When those items are selected by
7769     * the user, a callback function is issued. Users may interact with
7770     * a gengrid via the mouse (by clicking on items to select them and
7771     * clicking on the grid's viewport and swiping to pan the whole
7772     * view) or via the keyboard, navigating through item with the
7773     * arrow keys.
7774     *
7775     * @section Gengrid_Layouts Gengrid layouts
7776     *
7777     * Gengrid may layout its items in one of two possible layouts:
7778     * - horizontal or
7779     * - vertical.
7780     *
7781     * When in "horizontal mode", items will be placed in @b columns,
7782     * from top to bottom and, when the space for a column is filled,
7783     * another one is started on the right, thus expanding the grid
7784     * horizontally, making for horizontal scrolling. When in "vertical
7785     * mode" , though, items will be placed in @b rows, from left to
7786     * right and, when the space for a row is filled, another one is
7787     * started below, thus expanding the grid vertically (and making
7788     * for vertical scrolling).
7789     *
7790     * @section Gengrid_Items Gengrid items
7791     *
7792     * An item in a gengrid can have 0 or more text labels (they can be
7793     * regular text or textblock Evas objects - that's up to the style
7794     * to determine), 0 or more icons (which are simply objects
7795     * swallowed into the gengrid item's theming Edje object) and 0 or
7796     * more <b>boolean states</b>, which have the behavior left to the
7797     * user to define. The Edje part names for each of these properties
7798     * will be looked up, in the theme file for the gengrid, under the
7799     * Edje (string) data items named @c "labels", @c "icons" and @c
7800     * "states", respectively. For each of those properties, if more
7801     * than one part is provided, they must have names listed separated
7802     * by spaces in the data fields. For the default gengrid item
7803     * theme, we have @b one label part (@c "elm.text"), @b two icon
7804     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7805     * no state parts.
7806     *
7807     * A gengrid item may be at one of several styles. Elementary
7808     * provides one by default - "default", but this can be extended by
7809     * system or application custom themes/overlays/extensions (see
7810     * @ref Theme "themes" for more details).
7811     *
7812     * @section Gengrid_Item_Class Gengrid item classes
7813     *
7814     * In order to have the ability to add and delete items on the fly,
7815     * gengrid implements a class (callback) system where the
7816     * application provides a structure with information about that
7817     * type of item (gengrid may contain multiple different items with
7818     * different classes, states and styles). Gengrid will call the
7819     * functions in this struct (methods) when an item is "realized"
7820     * (i.e., created dynamically, while the user is scrolling the
7821     * grid). All objects will simply be deleted when no longer needed
7822     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7823     * contains the following members:
7824     * - @c item_style - This is a constant string and simply defines
7825     * the name of the item style. It @b must be specified and the
7826     * default should be @c "default".
7827     * - @c func.label_get - This function is called when an item
7828     * object is actually created. The @c data parameter will point to
7829     * the same data passed to elm_gengrid_item_append() and related
7830     * item creation functions. The @c obj parameter is the gengrid
7831     * object itself, while the @c part one is the name string of one
7832     * of the existing text parts in the Edje group implementing the
7833     * item's theme. This function @b must return a strdup'()ed string,
7834     * as the caller will free() it when done. See
7835     * #GridItemLabelGetFunc.
7836     * - @c func.content_get - This function is called when an item object
7837     * is actually created. The @c data parameter will point to the
7838     * same data passed to elm_gengrid_item_append() and related item
7839     * creation functions. The @c obj parameter is the gengrid object
7840     * itself, while the @c part one is the name string of one of the
7841     * existing (content) swallow parts in the Edje group implementing the
7842     * item's theme. It must return @c NULL, when no content is desired,
7843     * or a valid object handle, otherwise. The object will be deleted
7844     * by the gengrid on its deletion or when the item is "unrealized".
7845     * See #GridItemIconGetFunc.
7846     * - @c func.state_get - This function is called when an item
7847     * object is actually created. The @c data parameter will point to
7848     * the same data passed to elm_gengrid_item_append() and related
7849     * item creation functions. The @c obj parameter is the gengrid
7850     * object itself, while the @c part one is the name string of one
7851     * of the state parts in the Edje group implementing the item's
7852     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7853     * true/on. Gengrids will emit a signal to its theming Edje object
7854     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7855     * "source" arguments, respectively, when the state is true (the
7856     * default is false), where @c XXX is the name of the (state) part.
7857     * See #GridItemStateGetFunc.
7858     * - @c func.del - This is called when elm_gengrid_item_del() is
7859     * called on an item or elm_gengrid_clear() is called on the
7860     * gengrid. This is intended for use when gengrid items are
7861     * deleted, so any data attached to the item (e.g. its data
7862     * parameter on creation) can be deleted. See #GridItemDelFunc.
7863     *
7864     * @section Gengrid_Usage_Hints Usage hints
7865     *
7866     * If the user wants to have multiple items selected at the same
7867     * time, elm_gengrid_multi_select_set() will permit it. If the
7868     * gengrid is single-selection only (the default), then
7869     * elm_gengrid_select_item_get() will return the selected item or
7870     * @c NULL, if none is selected. If the gengrid is under
7871     * multi-selection, then elm_gengrid_selected_items_get() will
7872     * return a list (that is only valid as long as no items are
7873     * modified (added, deleted, selected or unselected) of child items
7874     * on a gengrid.
7875     *
7876     * If an item changes (internal (boolean) state, label or content 
7877     * changes), then use elm_gengrid_item_update() to have gengrid
7878     * update the item with the new state. A gengrid will re-"realize"
7879     * the item, thus calling the functions in the
7880     * #Elm_Gengrid_Item_Class set for that item.
7881     *
7882     * To programmatically (un)select an item, use
7883     * elm_gengrid_item_selected_set(). To get its selected state use
7884     * elm_gengrid_item_selected_get(). To make an item disabled
7885     * (unable to be selected and appear differently) use
7886     * elm_gengrid_item_disabled_set() to set this and
7887     * elm_gengrid_item_disabled_get() to get the disabled state.
7888     *
7889     * Grid cells will only have their selection smart callbacks called
7890     * when firstly getting selected. Any further clicks will do
7891     * nothing, unless you enable the "always select mode", with
7892     * elm_gengrid_always_select_mode_set(), thus making every click to
7893     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7894     * turn off the ability to select items entirely in the widget and
7895     * they will neither appear selected nor call the selection smart
7896     * callbacks.
7897     *
7898     * Remember that you can create new styles and add your own theme
7899     * augmentation per application with elm_theme_extension_add(). If
7900     * you absolutely must have a specific style that overrides any
7901     * theme the user or system sets up you can use
7902     * elm_theme_overlay_add() to add such a file.
7903     *
7904     * @section Gengrid_Smart_Events Gengrid smart events
7905     *
7906     * Smart events that you can add callbacks for are:
7907     * - @c "activated" - The user has double-clicked or pressed
7908     *   (enter|return|spacebar) on an item. The @c event_info parameter
7909     *   is the gengrid item that was activated.
7910     * - @c "clicked,double" - The user has double-clicked an item.
7911     *   The @c event_info parameter is the gengrid item that was double-clicked.
7912     * - @c "longpressed" - This is called when the item is pressed for a certain
7913     *   amount of time. By default it's 1 second.
7914     * - @c "selected" - The user has made an item selected. The
7915     *   @c event_info parameter is the gengrid item that was selected.
7916     * - @c "unselected" - The user has made an item unselected. The
7917     *   @c event_info parameter is the gengrid item that was unselected.
7918     * - @c "realized" - This is called when the item in the gengrid
7919     *   has its implementing Evas object instantiated, de facto. @c
7920     *   event_info is the gengrid item that was created. The object
7921     *   may be deleted at any time, so it is highly advised to the
7922     *   caller @b not to use the object pointer returned from
7923     *   elm_gengrid_item_object_get(), because it may point to freed
7924     *   objects.
7925     * - @c "unrealized" - This is called when the implementing Evas
7926     *   object for this item is deleted. @c event_info is the gengrid
7927     *   item that was deleted.
7928     * - @c "changed" - Called when an item is added, removed, resized
7929     *   or moved and when the gengrid is resized or gets "horizontal"
7930     *   property changes.
7931     * - @c "scroll,anim,start" - This is called when scrolling animation has
7932     *   started.
7933     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7934     *   stopped.
7935     * - @c "drag,start,up" - Called when the item in the gengrid has
7936     *   been dragged (not scrolled) up.
7937     * - @c "drag,start,down" - Called when the item in the gengrid has
7938     *   been dragged (not scrolled) down.
7939     * - @c "drag,start,left" - Called when the item in the gengrid has
7940     *   been dragged (not scrolled) left.
7941     * - @c "drag,start,right" - Called when the item in the gengrid has
7942     *   been dragged (not scrolled) right.
7943     * - @c "drag,stop" - Called when the item in the gengrid has
7944     *   stopped being dragged.
7945     * - @c "drag" - Called when the item in the gengrid is being
7946     *   dragged.
7947     * - @c "scroll" - called when the content has been scrolled
7948     *   (moved).
7949     * - @c "scroll,drag,start" - called when dragging the content has
7950     *   started.
7951     * - @c "scroll,drag,stop" - called when dragging the content has
7952     *   stopped.
7953     * - @c "edge,top" - This is called when the gengrid is scrolled until
7954     *   the top edge.
7955     * - @c "edge,bottom" - This is called when the gengrid is scrolled
7956     *   until the bottom edge.
7957     * - @c "edge,left" - This is called when the gengrid is scrolled
7958     *   until the left edge.
7959     * - @c "edge,right" - This is called when the gengrid is scrolled
7960     *   until the right edge.
7961     *
7962     * List of gengrid examples:
7963     * @li @ref gengrid_example
7964     */
7965
7966    /**
7967     * @addtogroup Gengrid
7968     * @{
7969     */
7970
7971    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7972    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7973    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7974    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7975    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
7976    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
7977    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7978
7979    /**
7980     * @struct _Elm_Gengrid_Item_Class
7981     *
7982     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7983     * field details.
7984     */
7985    struct _Elm_Gengrid_Item_Class
7986      {
7987         const char             *item_style;
7988         struct _Elm_Gengrid_Item_Class_Func
7989           {
7990              GridItemLabelGetFunc  label_get;
7991              GridItemIconGetFunc   icon_get;
7992              GridItemStateGetFunc  state_get;
7993              GridItemDelFunc       del;
7994           } func;
7995      }; /**< #Elm_Gengrid_Item_Class member definitions */
7996    /**
7997     * Add a new gengrid widget to the given parent Elementary
7998     * (container) object
7999     *
8000     * @param parent The parent object
8001     * @return a new gengrid widget handle or @c NULL, on errors
8002     *
8003     * This function inserts a new gengrid widget on the canvas.
8004     *
8005     * @see elm_gengrid_item_size_set()
8006     * @see elm_gengrid_group_item_size_set()
8007     * @see elm_gengrid_horizontal_set()
8008     * @see elm_gengrid_item_append()
8009     * @see elm_gengrid_item_del()
8010     * @see elm_gengrid_clear()
8011     *
8012     * @ingroup Gengrid
8013     */
8014    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8015
8016    /**
8017     * Set the size for the items of a given gengrid widget
8018     *
8019     * @param obj The gengrid object.
8020     * @param w The items' width.
8021     * @param h The items' height;
8022     *
8023     * A gengrid, after creation, has still no information on the size
8024     * to give to each of its cells. So, you most probably will end up
8025     * with squares one @ref Fingers "finger" wide, the default
8026     * size. Use this function to force a custom size for you items,
8027     * making them as big as you wish.
8028     *
8029     * @see elm_gengrid_item_size_get()
8030     *
8031     * @ingroup Gengrid
8032     */
8033    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8034
8035    /**
8036     * Get the size set for the items of a given gengrid widget
8037     *
8038     * @param obj The gengrid object.
8039     * @param w Pointer to a variable where to store the items' width.
8040     * @param h Pointer to a variable where to store the items' height.
8041     *
8042     * @note Use @c NULL pointers on the size values you're not
8043     * interested in: they'll be ignored by the function.
8044     *
8045     * @see elm_gengrid_item_size_get() for more details
8046     *
8047     * @ingroup Gengrid
8048     */
8049    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8050
8051    /**
8052     * Set the items grid's alignment within a given gengrid widget
8053     *
8054     * @param obj The gengrid object.
8055     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8056     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8057     *
8058     * This sets the alignment of the whole grid of items of a gengrid
8059     * within its given viewport. By default, those values are both
8060     * 0.5, meaning that the gengrid will have its items grid placed
8061     * exactly in the middle of its viewport.
8062     *
8063     * @note If given alignment values are out of the cited ranges,
8064     * they'll be changed to the nearest boundary values on the valid
8065     * ranges.
8066     *
8067     * @see elm_gengrid_align_get()
8068     *
8069     * @ingroup Gengrid
8070     */
8071    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8072
8073    /**
8074     * Get the items grid's alignment values within a given gengrid
8075     * widget
8076     *
8077     * @param obj The gengrid object.
8078     * @param align_x Pointer to a variable where to store the
8079     * horizontal alignment.
8080     * @param align_y Pointer to a variable where to store the vertical
8081     * alignment.
8082     *
8083     * @note Use @c NULL pointers on the alignment values you're not
8084     * interested in: they'll be ignored by the function.
8085     *
8086     * @see elm_gengrid_align_set() for more details
8087     *
8088     * @ingroup Gengrid
8089     */
8090    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8091
8092    /**
8093     * Set whether a given gengrid widget is or not able have items
8094     * @b reordered
8095     *
8096     * @param obj The gengrid object
8097     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8098     * @c EINA_FALSE to turn it off
8099     *
8100     * If a gengrid is set to allow reordering, a click held for more
8101     * than 0.5 over a given item will highlight it specially,
8102     * signalling the gengrid has entered the reordering state. From
8103     * that time on, the user will be able to, while still holding the
8104     * mouse button down, move the item freely in the gengrid's
8105     * viewport, replacing to said item to the locations it goes to.
8106     * The replacements will be animated and, whenever the user
8107     * releases the mouse button, the item being replaced gets a new
8108     * definitive place in the grid.
8109     *
8110     * @see elm_gengrid_reorder_mode_get()
8111     *
8112     * @ingroup Gengrid
8113     */
8114    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8115
8116    /**
8117     * Get whether a given gengrid widget is or not able have items
8118     * @b reordered
8119     *
8120     * @param obj The gengrid object
8121     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8122     * off
8123     *
8124     * @see elm_gengrid_reorder_mode_set() for more details
8125     *
8126     * @ingroup Gengrid
8127     */
8128    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8129
8130    /**
8131     * Append a new item in a given gengrid widget.
8132     *
8133     * @param obj The gengrid object.
8134     * @param gic The item class for the item.
8135     * @param data The item data.
8136     * @param func Convenience function called when the item is
8137     * selected.
8138     * @param func_data Data to be passed to @p func.
8139     * @return A handle to the item added or @c NULL, on errors.
8140     *
8141     * This adds an item to the beginning of the gengrid.
8142     *
8143     * @see elm_gengrid_item_prepend()
8144     * @see elm_gengrid_item_insert_before()
8145     * @see elm_gengrid_item_insert_after()
8146     * @see elm_gengrid_item_del()
8147     *
8148     * @ingroup Gengrid
8149     */
8150    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);
8151
8152    /**
8153     * Prepend a new item in a given gengrid widget.
8154     *
8155     * @param obj The gengrid object.
8156     * @param gic The item class for the item.
8157     * @param data The item data.
8158     * @param func Convenience function called when the item is
8159     * selected.
8160     * @param func_data Data to be passed to @p func.
8161     * @return A handle to the item added or @c NULL, on errors.
8162     *
8163     * This adds an item to the end of the gengrid.
8164     *
8165     * @see elm_gengrid_item_append()
8166     * @see elm_gengrid_item_insert_before()
8167     * @see elm_gengrid_item_insert_after()
8168     * @see elm_gengrid_item_del()
8169     *
8170     * @ingroup Gengrid
8171     */
8172    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);
8173
8174    /**
8175     * Insert an item before another in a gengrid widget
8176     *
8177     * @param obj The gengrid object.
8178     * @param gic The item class for the item.
8179     * @param data The item data.
8180     * @param relative The item to place this new one before.
8181     * @param func Convenience function called when the item is
8182     * selected.
8183     * @param func_data Data to be passed to @p func.
8184     * @return A handle to the item added or @c NULL, on errors.
8185     *
8186     * This inserts an item before another in the gengrid.
8187     *
8188     * @see elm_gengrid_item_append()
8189     * @see elm_gengrid_item_prepend()
8190     * @see elm_gengrid_item_insert_after()
8191     * @see elm_gengrid_item_del()
8192     *
8193     * @ingroup Gengrid
8194     */
8195    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);
8196
8197    /**
8198     * Insert an item after another in a gengrid widget
8199     *
8200     * @param obj The gengrid object.
8201     * @param gic The item class for the item.
8202     * @param data The item data.
8203     * @param relative The item to place this new one after.
8204     * @param func Convenience function called when the item is
8205     * selected.
8206     * @param func_data Data to be passed to @p func.
8207     * @return A handle to the item added or @c NULL, on errors.
8208     *
8209     * This inserts an item after another in the gengrid.
8210     *
8211     * @see elm_gengrid_item_append()
8212     * @see elm_gengrid_item_prepend()
8213     * @see elm_gengrid_item_insert_after()
8214     * @see elm_gengrid_item_del()
8215     *
8216     * @ingroup Gengrid
8217     */
8218    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);
8219
8220    /**
8221     * Insert an item in a gengrid widget using a user-defined sort function.
8222     *
8223     * @param obj The gengrid object.
8224     * @param gic The item class for the item.
8225     * @param data The item data.
8226     * @param comp User defined comparison function that defines the sort order based on
8227     * Elm_Gen_Item and its data param.
8228     * @param func Convenience function called when the item is selected.
8229     * @param func_data Data to be passed to @p func.
8230     * @return A handle to the item added or @c NULL, on errors.
8231     *
8232     * This inserts an item in the gengrid based on user defined comparison function.
8233     *
8234     * @see elm_gengrid_item_append()
8235     * @see elm_gengrid_item_prepend()
8236     * @see elm_gengrid_item_insert_after()
8237     * @see elm_gengrid_item_del()
8238     * @see elm_gengrid_item_direct_sorted_insert()
8239     *
8240     * @ingroup Gengrid
8241     */
8242    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);
8243
8244    /**
8245     * Insert an item in a gengrid widget using a user-defined sort function.
8246     *
8247     * @param obj The gengrid object.
8248     * @param gic The item class for the item.
8249     * @param data The item data.
8250     * @param comp User defined comparison function that defines the sort order based on
8251     * Elm_Gen_Item.
8252     * @param func Convenience function called when the item is selected.
8253     * @param func_data Data to be passed to @p func.
8254     * @return A handle to the item added or @c NULL, on errors.
8255     *
8256     * This inserts an item in the gengrid based on user defined comparison function.
8257     *
8258     * @see elm_gengrid_item_append()
8259     * @see elm_gengrid_item_prepend()
8260     * @see elm_gengrid_item_insert_after()
8261     * @see elm_gengrid_item_del()
8262     * @see elm_gengrid_item_sorted_insert()
8263     *
8264     * @ingroup Gengrid
8265     */
8266    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);
8267
8268    /**
8269     * Set whether items on a given gengrid widget are to get their
8270     * selection callbacks issued for @b every subsequent selection
8271     * click on them or just for the first click.
8272     *
8273     * @param obj The gengrid object
8274     * @param always_select @c EINA_TRUE to make items "always
8275     * selected", @c EINA_FALSE, otherwise
8276     *
8277     * By default, grid items will only call their selection callback
8278     * function when firstly getting selected, any subsequent further
8279     * clicks will do nothing. With this call, you make those
8280     * subsequent clicks also to issue the selection callbacks.
8281     *
8282     * @note <b>Double clicks</b> will @b always be reported on items.
8283     *
8284     * @see elm_gengrid_always_select_mode_get()
8285     *
8286     * @ingroup Gengrid
8287     */
8288    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8289
8290    /**
8291     * Get whether items on a given gengrid widget have their selection
8292     * callbacks issued for @b every subsequent selection click on them
8293     * or just for the first click.
8294     *
8295     * @param obj The gengrid object.
8296     * @return @c EINA_TRUE if the gengrid items are "always selected",
8297     * @c EINA_FALSE, otherwise
8298     *
8299     * @see elm_gengrid_always_select_mode_set() for more details
8300     *
8301     * @ingroup Gengrid
8302     */
8303    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8304
8305    /**
8306     * Set whether items on a given gengrid widget can be selected or not.
8307     *
8308     * @param obj The gengrid object
8309     * @param no_select @c EINA_TRUE to make items selectable,
8310     * @c EINA_FALSE otherwise
8311     *
8312     * This will make items in @p obj selectable or not. In the latter
8313     * case, any user interaction on the gengrid items will neither make
8314     * them appear selected nor them call their selection callback
8315     * functions.
8316     *
8317     * @see elm_gengrid_no_select_mode_get()
8318     *
8319     * @ingroup Gengrid
8320     */
8321    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8322
8323    /**
8324     * Get whether items on a given gengrid widget can be selected or
8325     * not.
8326     *
8327     * @param obj The gengrid object
8328     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8329     * otherwise
8330     *
8331     * @see elm_gengrid_no_select_mode_set() for more details
8332     *
8333     * @ingroup Gengrid
8334     */
8335    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8336
8337    /**
8338     * Enable or disable multi-selection in a given gengrid widget
8339     *
8340     * @param obj The gengrid object.
8341     * @param multi @c EINA_TRUE, to enable multi-selection,
8342     * @c EINA_FALSE to disable it.
8343     *
8344     * Multi-selection is the ability to have @b more than one
8345     * item selected, on a given gengrid, simultaneously. When it is
8346     * enabled, a sequence of clicks on different items will make them
8347     * all selected, progressively. A click on an already selected item
8348     * will unselect it. If interacting via the keyboard,
8349     * multi-selection is enabled while holding the "Shift" key.
8350     *
8351     * @note By default, multi-selection is @b disabled on gengrids
8352     *
8353     * @see elm_gengrid_multi_select_get()
8354     *
8355     * @ingroup Gengrid
8356     */
8357    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8358
8359    /**
8360     * Get whether multi-selection is enabled or disabled for a given
8361     * gengrid widget
8362     *
8363     * @param obj The gengrid object.
8364     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8365     * EINA_FALSE otherwise
8366     *
8367     * @see elm_gengrid_multi_select_set() for more details
8368     *
8369     * @ingroup Gengrid
8370     */
8371    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8372
8373    /**
8374     * Enable or disable bouncing effect for a given gengrid widget
8375     *
8376     * @param obj The gengrid object
8377     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8378     * @c EINA_FALSE to disable it
8379     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8380     * @c EINA_FALSE to disable it
8381     *
8382     * The bouncing effect occurs whenever one reaches the gengrid's
8383     * edge's while panning it -- it will scroll past its limits a
8384     * little bit and return to the edge again, in a animated for,
8385     * automatically.
8386     *
8387     * @note By default, gengrids have bouncing enabled on both axis
8388     *
8389     * @see elm_gengrid_bounce_get()
8390     *
8391     * @ingroup Gengrid
8392     */
8393    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8394
8395    /**
8396     * Get whether bouncing effects are enabled or disabled, for a
8397     * given gengrid widget, on each axis
8398     *
8399     * @param obj The gengrid object
8400     * @param h_bounce Pointer to a variable where to store the
8401     * horizontal bouncing flag.
8402     * @param v_bounce Pointer to a variable where to store the
8403     * vertical bouncing flag.
8404     *
8405     * @see elm_gengrid_bounce_set() for more details
8406     *
8407     * @ingroup Gengrid
8408     */
8409    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8410
8411    /**
8412     * Set a given gengrid widget's scrolling page size, relative to
8413     * its viewport size.
8414     *
8415     * @param obj The gengrid object
8416     * @param h_pagerel The horizontal page (relative) size
8417     * @param v_pagerel The vertical page (relative) size
8418     *
8419     * The gengrid's scroller is capable of binding scrolling by the
8420     * user to "pages". It means that, while scrolling and, specially
8421     * after releasing the mouse button, the grid will @b snap to the
8422     * nearest displaying page's area. When page sizes are set, the
8423     * grid's continuous content area is split into (equal) page sized
8424     * pieces.
8425     *
8426     * This function sets the size of a page <b>relatively to the
8427     * viewport dimensions</b> of the gengrid, for each axis. A value
8428     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8429     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8430     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8431     * 1.0. Values beyond those will make it behave behave
8432     * inconsistently. If you only want one axis to snap to pages, use
8433     * the value @c 0.0 for the other one.
8434     *
8435     * There is a function setting page size values in @b absolute
8436     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8437     * is mutually exclusive to this one.
8438     *
8439     * @see elm_gengrid_page_relative_get()
8440     *
8441     * @ingroup Gengrid
8442     */
8443    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8444
8445    /**
8446     * Get a given gengrid widget's scrolling page size, relative to
8447     * its viewport size.
8448     *
8449     * @param obj The gengrid object
8450     * @param h_pagerel Pointer to a variable where to store the
8451     * horizontal page (relative) size
8452     * @param v_pagerel Pointer to a variable where to store the
8453     * vertical page (relative) size
8454     *
8455     * @see elm_gengrid_page_relative_set() for more details
8456     *
8457     * @ingroup Gengrid
8458     */
8459    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8460
8461    /**
8462     * Set a given gengrid widget's scrolling page size
8463     *
8464     * @param obj The gengrid object
8465     * @param h_pagerel The horizontal page size, in pixels
8466     * @param v_pagerel The vertical page size, in pixels
8467     *
8468     * The gengrid's scroller is capable of binding scrolling by the
8469     * user to "pages". It means that, while scrolling and, specially
8470     * after releasing the mouse button, the grid will @b snap to the
8471     * nearest displaying page's area. When page sizes are set, the
8472     * grid's continuous content area is split into (equal) page sized
8473     * pieces.
8474     *
8475     * This function sets the size of a page of the gengrid, in pixels,
8476     * for each axis. Sane usable values are, between @c 0 and the
8477     * dimensions of @p obj, for each axis. Values beyond those will
8478     * make it behave behave inconsistently. If you only want one axis
8479     * to snap to pages, use the value @c 0 for the other one.
8480     *
8481     * There is a function setting page size values in @b relative
8482     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8483     * use is mutually exclusive to this one.
8484     *
8485     * @ingroup Gengrid
8486     */
8487    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8488
8489    /**
8490     * Set the direction in which a given gengrid widget will expand while
8491     * placing its items.
8492     *
8493     * @param obj The gengrid object.
8494     * @param setting @c EINA_TRUE to make the gengrid expand
8495     * horizontally, @c EINA_FALSE to expand vertically.
8496     *
8497     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8498     * in @b columns, from top to bottom and, when the space for a
8499     * column is filled, another one is started on the right, thus
8500     * expanding the grid horizontally. When in "vertical mode"
8501     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8502     * to right and, when the space for a row is filled, another one is
8503     * started below, thus expanding the grid vertically.
8504     *
8505     * @see elm_gengrid_horizontal_get()
8506     *
8507     * @ingroup Gengrid
8508     */
8509    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8510
8511    /**
8512     * Get for what direction a given gengrid widget will expand while
8513     * placing its items.
8514     *
8515     * @param obj The gengrid object.
8516     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8517     * @c EINA_FALSE if it's set to expand vertically.
8518     *
8519     * @see elm_gengrid_horizontal_set() for more detais
8520     *
8521     * @ingroup Gengrid
8522     */
8523    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8524
8525    /**
8526     * Get the first item in a given gengrid widget
8527     *
8528     * @param obj The gengrid object
8529     * @return The first item's handle or @c NULL, if there are no
8530     * items in @p obj (and on errors)
8531     *
8532     * This returns the first item in the @p obj's internal list of
8533     * items.
8534     *
8535     * @see elm_gengrid_last_item_get()
8536     *
8537     * @ingroup Gengrid
8538     */
8539    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8540
8541    /**
8542     * Get the last item in a given gengrid widget
8543     *
8544     * @param obj The gengrid object
8545     * @return The last item's handle or @c NULL, if there are no
8546     * items in @p obj (and on errors)
8547     *
8548     * This returns the last item in the @p obj's internal list of
8549     * items.
8550     *
8551     * @see elm_gengrid_first_item_get()
8552     *
8553     * @ingroup Gengrid
8554     */
8555    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8556
8557    /**
8558     * Get the @b next item in a gengrid widget's internal list of items,
8559     * given a handle to one of those items.
8560     *
8561     * @param item The gengrid item to fetch next from
8562     * @return The item after @p item, or @c NULL if there's none (and
8563     * on errors)
8564     *
8565     * This returns the item placed after the @p item, on the container
8566     * gengrid.
8567     *
8568     * @see elm_gengrid_item_prev_get()
8569     *
8570     * @ingroup Gengrid
8571     */
8572    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8573
8574    /**
8575     * Get the @b previous item in a gengrid widget's internal list of items,
8576     * given a handle to one of those items.
8577     *
8578     * @param item The gengrid item to fetch previous from
8579     * @return The item before @p item, or @c NULL if there's none (and
8580     * on errors)
8581     *
8582     * This returns the item placed before the @p item, on the container
8583     * gengrid.
8584     *
8585     * @see elm_gengrid_item_next_get()
8586     *
8587     * @ingroup Gengrid
8588     */
8589    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8590
8591    /**
8592     * Get the gengrid object's handle which contains a given gengrid
8593     * item
8594     *
8595     * @param item The item to fetch the container from
8596     * @return The gengrid (parent) object
8597     *
8598     * This returns the gengrid object itself that an item belongs to.
8599     *
8600     * @ingroup Gengrid
8601     */
8602    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8603
8604    /**
8605     * Remove a gengrid item from its parent, deleting it.
8606     *
8607     * @param item The item to be removed.
8608     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8609     *
8610     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8611     * once.
8612     *
8613     * @ingroup Gengrid
8614     */
8615    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8616
8617    /**
8618     * Update the contents of a given gengrid item
8619     *
8620     * @param item The gengrid item
8621     *
8622     * This updates an item by calling all the item class functions
8623     * again to get the contents, labels and states. Use this when the
8624     * original item data has changed and you want the changes to be
8625     * reflected.
8626     *
8627     * @ingroup Gengrid
8628     */
8629    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8630
8631    /**
8632     * Get the Gengrid Item class for the given Gengrid Item.
8633     *
8634     * @param item The gengrid item
8635     *
8636     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8637     * the function pointers and item_style.
8638     *
8639     * @ingroup Gengrid
8640     */
8641    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8642
8643    /**
8644     * Get the Gengrid Item class for the given Gengrid Item.
8645     *
8646     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8647     * the function pointers and item_style.
8648     *
8649     * @param item The gengrid item
8650     * @param gic The gengrid item class describing the function pointers and the item style.
8651     *
8652     * @ingroup Gengrid
8653     */
8654    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8655
8656    /**
8657     * Return the data associated to a given gengrid item
8658     *
8659     * @param item The gengrid item.
8660     * @return the data associated with this item.
8661     *
8662     * This returns the @c data value passed on the
8663     * elm_gengrid_item_append() and related item addition calls.
8664     *
8665     * @see elm_gengrid_item_append()
8666     * @see elm_gengrid_item_data_set()
8667     *
8668     * @ingroup Gengrid
8669     */
8670    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8671
8672    /**
8673     * Set the data associated with a given gengrid item
8674     *
8675     * @param item The gengrid item
8676     * @param data The data pointer to set on it
8677     *
8678     * This @b overrides the @c data value passed on the
8679     * elm_gengrid_item_append() and related item addition calls. This
8680     * function @b won't call elm_gengrid_item_update() automatically,
8681     * so you'd issue it afterwards if you want to have the item
8682     * updated to reflect the new data.
8683     *
8684     * @see elm_gengrid_item_data_get()
8685     * @see elm_gengrid_item_update()
8686     *
8687     * @ingroup Gengrid
8688     */
8689    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8690
8691    /**
8692     * Get a given gengrid item's position, relative to the whole
8693     * gengrid's grid area.
8694     *
8695     * @param item The Gengrid item.
8696     * @param x Pointer to variable to store the item's <b>row number</b>.
8697     * @param y Pointer to variable to store the item's <b>column number</b>.
8698     *
8699     * This returns the "logical" position of the item within the
8700     * gengrid. For example, @c (0, 1) would stand for first row,
8701     * second column.
8702     *
8703     * @ingroup Gengrid
8704     */
8705    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8706
8707    /**
8708     * Set whether a given gengrid item is selected or not
8709     *
8710     * @param item The gengrid item
8711     * @param selected Use @c EINA_TRUE, to make it selected, @c
8712     * EINA_FALSE to make it unselected
8713     *
8714     * This sets the selected state of an item. If multi-selection is
8715     * not enabled on the containing gengrid and @p selected is @c
8716     * EINA_TRUE, any other previously selected items will get
8717     * unselected in favor of this new one.
8718     *
8719     * @see elm_gengrid_item_selected_get()
8720     *
8721     * @ingroup Gengrid
8722     */
8723    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8724
8725    /**
8726     * Get whether a given gengrid item is selected or not
8727     *
8728     * @param item The gengrid item
8729     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8730     *
8731     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8732     *
8733     * @see elm_gengrid_item_selected_set() for more details
8734     *
8735     * @ingroup Gengrid
8736     */
8737    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8738
8739    /**
8740     * Get the real Evas object created to implement the view of a
8741     * given gengrid item
8742     *
8743     * @param item The gengrid item.
8744     * @return the Evas object implementing this item's view.
8745     *
8746     * This returns the actual Evas object used to implement the
8747     * specified gengrid item's view. This may be @c NULL, as it may
8748     * not have been created or may have been deleted, at any time, by
8749     * the gengrid. <b>Do not modify this object</b> (move, resize,
8750     * show, hide, etc.), as the gengrid is controlling it. This
8751     * function is for querying, emitting custom signals or hooking
8752     * lower level callbacks for events on that object. Do not delete
8753     * this object under any circumstances.
8754     *
8755     * @see elm_gengrid_item_data_get()
8756     *
8757     * @ingroup Gengrid
8758     */
8759    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8760
8761    /**
8762     * Show the portion of a gengrid's internal grid containing a given
8763     * item, @b immediately.
8764     *
8765     * @param item The item to display
8766     *
8767     * This causes gengrid to @b redraw its viewport's contents to the
8768     * region contining the given @p item item, if it is not fully
8769     * visible.
8770     *
8771     * @see elm_gengrid_item_bring_in()
8772     *
8773     * @ingroup Gengrid
8774     */
8775    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8776
8777    /**
8778     * Animatedly bring in, to the visible area of a gengrid, a given
8779     * item on it.
8780     *
8781     * @param item The gengrid item to display
8782     *
8783     * This causes gengrid to jump to the given @p item and show
8784     * it (by scrolling), if it is not fully visible. This will use
8785     * animation to do so and take a period of time to complete.
8786     *
8787     * @see elm_gengrid_item_show()
8788     *
8789     * @ingroup Gengrid
8790     */
8791    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8792
8793    /**
8794     * Set whether a given gengrid item is disabled or not.
8795     *
8796     * @param item The gengrid item
8797     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8798     * to enable it back.
8799     *
8800     * A disabled item cannot be selected or unselected. It will also
8801     * change its appearance, to signal the user it's disabled.
8802     *
8803     * @see elm_gengrid_item_disabled_get()
8804     *
8805     * @ingroup Gengrid
8806     */
8807    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8808
8809    /**
8810     * Get whether a given gengrid item is disabled or not.
8811     *
8812     * @param item The gengrid item
8813     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8814     * (and on errors).
8815     *
8816     * @see elm_gengrid_item_disabled_set() for more details
8817     *
8818     * @ingroup Gengrid
8819     */
8820    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8821
8822    /**
8823     * Set the text to be shown in a given gengrid item's tooltips.
8824     *
8825     * @param item The gengrid item
8826     * @param text The text to set in the content
8827     *
8828     * This call will setup the text to be used as tooltip to that item
8829     * (analogous to elm_object_tooltip_text_set(), but being item
8830     * tooltips with higher precedence than object tooltips). It can
8831     * have only one tooltip at a time, so any previous tooltip data
8832     * will get removed.
8833     *
8834     * @ingroup Gengrid
8835     */
8836    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8837
8838    /**
8839     * Set the content to be shown in a given gengrid item's tooltip
8840     *
8841     * @param item The gengrid item.
8842     * @param func The function returning the tooltip contents.
8843     * @param data What to provide to @a func as callback data/context.
8844     * @param del_cb Called when data is not needed anymore, either when
8845     *        another callback replaces @p func, the tooltip is unset with
8846     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8847     *        dies. This callback receives as its first parameter the
8848     *        given @p data, being @c event_info the item handle.
8849     *
8850     * This call will setup the tooltip's contents to @p item
8851     * (analogous to elm_object_tooltip_content_cb_set(), but being
8852     * item tooltips with higher precedence than object tooltips). It
8853     * can have only one tooltip at a time, so any previous tooltip
8854     * content will get removed. @p func (with @p data) will be called
8855     * every time Elementary needs to show the tooltip and it should
8856     * return a valid Evas object, which will be fully managed by the
8857     * tooltip system, getting deleted when the tooltip is gone.
8858     *
8859     * @ingroup Gengrid
8860     */
8861    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);
8862
8863    /**
8864     * Unset a tooltip from a given gengrid item
8865     *
8866     * @param item gengrid item to remove a previously set tooltip from.
8867     *
8868     * This call removes any tooltip set on @p item. The callback
8869     * provided as @c del_cb to
8870     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8871     * notify it is not used anymore (and have resources cleaned, if
8872     * need be).
8873     *
8874     * @see elm_gengrid_item_tooltip_content_cb_set()
8875     *
8876     * @ingroup Gengrid
8877     */
8878    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8879
8880    /**
8881     * Set a different @b style for a given gengrid item's tooltip.
8882     *
8883     * @param item gengrid item with tooltip set
8884     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8885     * "default", @c "transparent", etc)
8886     *
8887     * Tooltips can have <b>alternate styles</b> to be displayed on,
8888     * which are defined by the theme set on Elementary. This function
8889     * works analogously as elm_object_tooltip_style_set(), but here
8890     * applied only to gengrid item objects. The default style for
8891     * tooltips is @c "default".
8892     *
8893     * @note before you set a style you should define a tooltip with
8894     *       elm_gengrid_item_tooltip_content_cb_set() or
8895     *       elm_gengrid_item_tooltip_text_set()
8896     *
8897     * @see elm_gengrid_item_tooltip_style_get()
8898     *
8899     * @ingroup Gengrid
8900     */
8901    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8902
8903    /**
8904     * Get the style set a given gengrid item's tooltip.
8905     *
8906     * @param item gengrid item with tooltip already set on.
8907     * @return style the theme style in use, which defaults to
8908     *         "default". If the object does not have a tooltip set,
8909     *         then @c NULL is returned.
8910     *
8911     * @see elm_gengrid_item_tooltip_style_set() for more details
8912     *
8913     * @ingroup Gengrid
8914     */
8915    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8916    /**
8917     * Set the type of mouse pointer/cursor decoration to be shown,
8918     * when the mouse pointer is over the given gengrid widget item
8919     *
8920     * @param item gengrid item to customize cursor on
8921     * @param cursor the cursor type's name
8922     *
8923     * This function works analogously as elm_object_cursor_set(), but
8924     * here the cursor's changing area is restricted to the item's
8925     * area, and not the whole widget's. Note that that item cursors
8926     * have precedence over widget cursors, so that a mouse over @p
8927     * item will always show cursor @p type.
8928     *
8929     * If this function is called twice for an object, a previously set
8930     * cursor will be unset on the second call.
8931     *
8932     * @see elm_object_cursor_set()
8933     * @see elm_gengrid_item_cursor_get()
8934     * @see elm_gengrid_item_cursor_unset()
8935     *
8936     * @ingroup Gengrid
8937     */
8938    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8939
8940    /**
8941     * Get the type of mouse pointer/cursor decoration set to be shown,
8942     * when the mouse pointer is over the given gengrid widget item
8943     *
8944     * @param item gengrid item with custom cursor set
8945     * @return the cursor type's name or @c NULL, if no custom cursors
8946     * were set to @p item (and on errors)
8947     *
8948     * @see elm_object_cursor_get()
8949     * @see elm_gengrid_item_cursor_set() for more details
8950     * @see elm_gengrid_item_cursor_unset()
8951     *
8952     * @ingroup Gengrid
8953     */
8954    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8955
8956    /**
8957     * Unset any custom mouse pointer/cursor decoration set to be
8958     * shown, when the mouse pointer is over the given gengrid widget
8959     * item, thus making it show the @b default cursor again.
8960     *
8961     * @param item a gengrid item
8962     *
8963     * Use this call to undo any custom settings on this item's cursor
8964     * decoration, bringing it back to defaults (no custom style set).
8965     *
8966     * @see elm_object_cursor_unset()
8967     * @see elm_gengrid_item_cursor_set() for more details
8968     *
8969     * @ingroup Gengrid
8970     */
8971    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8972
8973    /**
8974     * Set a different @b style for a given custom cursor set for a
8975     * gengrid item.
8976     *
8977     * @param item gengrid item with custom cursor set
8978     * @param style the <b>theme style</b> to use (e.g. @c "default",
8979     * @c "transparent", etc)
8980     *
8981     * This function only makes sense when one is using custom mouse
8982     * cursor decorations <b>defined in a theme file</b> , which can
8983     * have, given a cursor name/type, <b>alternate styles</b> on
8984     * it. It works analogously as elm_object_cursor_style_set(), but
8985     * here applied only to gengrid item objects.
8986     *
8987     * @warning Before you set a cursor style you should have defined a
8988     *       custom cursor previously on the item, with
8989     *       elm_gengrid_item_cursor_set()
8990     *
8991     * @see elm_gengrid_item_cursor_engine_only_set()
8992     * @see elm_gengrid_item_cursor_style_get()
8993     *
8994     * @ingroup Gengrid
8995     */
8996    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8997
8998    /**
8999     * Get the current @b style set for a given gengrid item's custom
9000     * cursor
9001     *
9002     * @param item gengrid item with custom cursor set.
9003     * @return style the cursor style in use. If the object does not
9004     *         have a cursor set, then @c NULL is returned.
9005     *
9006     * @see elm_gengrid_item_cursor_style_set() for more details
9007     *
9008     * @ingroup Gengrid
9009     */
9010    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9011
9012    /**
9013     * Set if the (custom) cursor for a given gengrid item should be
9014     * searched in its theme, also, or should only rely on the
9015     * rendering engine.
9016     *
9017     * @param item item with custom (custom) cursor already set on
9018     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9019     * only on those provided by the rendering engine, @c EINA_FALSE to
9020     * have them searched on the widget's theme, as well.
9021     *
9022     * @note This call is of use only if you've set a custom cursor
9023     * for gengrid items, with elm_gengrid_item_cursor_set().
9024     *
9025     * @note By default, cursors will only be looked for between those
9026     * provided by the rendering engine.
9027     *
9028     * @ingroup Gengrid
9029     */
9030    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9031
9032    /**
9033     * Get if the (custom) cursor for a given gengrid item is being
9034     * searched in its theme, also, or is only relying on the rendering
9035     * engine.
9036     *
9037     * @param item a gengrid item
9038     * @return @c EINA_TRUE, if cursors are being looked for only on
9039     * those provided by the rendering engine, @c EINA_FALSE if they
9040     * are being searched on the widget's theme, as well.
9041     *
9042     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9043     *
9044     * @ingroup Gengrid
9045     */
9046    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9047
9048    /**
9049     * Remove all items from a given gengrid widget
9050     *
9051     * @param obj The gengrid object.
9052     *
9053     * This removes (and deletes) all items in @p obj, leaving it
9054     * empty.
9055     *
9056     * @see elm_gengrid_item_del(), to remove just one item.
9057     *
9058     * @ingroup Gengrid
9059     */
9060    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9061
9062    /**
9063     * Get the selected item in a given gengrid widget
9064     *
9065     * @param obj The gengrid object.
9066     * @return The selected item's handleor @c NULL, if none is
9067     * selected at the moment (and on errors)
9068     *
9069     * This returns the selected item in @p obj. If multi selection is
9070     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9071     * the first item in the list is selected, which might not be very
9072     * useful. For that case, see elm_gengrid_selected_items_get().
9073     *
9074     * @ingroup Gengrid
9075     */
9076    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9077
9078    /**
9079     * Get <b>a list</b> of selected items in a given gengrid
9080     *
9081     * @param obj The gengrid object.
9082     * @return The list of selected items or @c NULL, if none is
9083     * selected at the moment (and on errors)
9084     *
9085     * This returns a list of the selected items, in the order that
9086     * they appear in the grid. This list is only valid as long as no
9087     * more items are selected or unselected (or unselected implictly
9088     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9089     * data, naturally.
9090     *
9091     * @see elm_gengrid_selected_item_get()
9092     *
9093     * @ingroup Gengrid
9094     */
9095    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9096
9097    /**
9098     * @}
9099     */
9100
9101    /**
9102     * @defgroup Clock Clock
9103     *
9104     * This is a @b digital clock widget. In its default theme, it has a
9105     * vintage "flipping numbers clock" appearance, which will animate
9106     * sheets of individual algarisms individually as time goes by.
9107     *
9108     * A newly created clock will fetch system's time (already
9109     * considering local time adjustments) to start with, and will tick
9110     * accondingly. It may or may not show seconds.
9111     *
9112     * Clocks have an @b edition mode. When in it, the sheets will
9113     * display extra arrow indications on the top and bottom and the
9114     * user may click on them to raise or lower the time values. After
9115     * it's told to exit edition mode, it will keep ticking with that
9116     * new time set (it keeps the difference from local time).
9117     *
9118     * Also, when under edition mode, user clicks on the cited arrows
9119     * which are @b held for some time will make the clock to flip the
9120     * sheet, thus editing the time, continuosly and automatically for
9121     * the user. The interval between sheet flips will keep growing in
9122     * time, so that it helps the user to reach a time which is distant
9123     * from the one set.
9124     *
9125     * The time display is, by default, in military mode (24h), but an
9126     * am/pm indicator may be optionally shown, too, when it will
9127     * switch to 12h.
9128     *
9129     * Smart callbacks one can register to:
9130     * - "changed" - the clock's user changed the time
9131     *
9132     * Here is an example on its usage:
9133     * @li @ref clock_example
9134     */
9135
9136    /**
9137     * @addtogroup Clock
9138     * @{
9139     */
9140
9141    /**
9142     * Identifiers for which clock digits should be editable, when a
9143     * clock widget is in edition mode. Values may be ORed together to
9144     * make a mask, naturally.
9145     *
9146     * @see elm_clock_edit_set()
9147     * @see elm_clock_digit_edit_set()
9148     */
9149    typedef enum _Elm_Clock_Digedit
9150      {
9151         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9152         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9153         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9154         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9155         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9156         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9157         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9158         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9159      } Elm_Clock_Digedit;
9160
9161    /**
9162     * Add a new clock widget to the given parent Elementary
9163     * (container) object
9164     *
9165     * @param parent The parent object
9166     * @return a new clock widget handle or @c NULL, on errors
9167     *
9168     * This function inserts a new clock widget on the canvas.
9169     *
9170     * @ingroup Clock
9171     */
9172    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9173
9174    /**
9175     * Set a clock widget's time, programmatically
9176     *
9177     * @param obj The clock widget object
9178     * @param hrs The hours to set
9179     * @param min The minutes to set
9180     * @param sec The secondes to set
9181     *
9182     * This function updates the time that is showed by the clock
9183     * widget.
9184     *
9185     *  Values @b must be set within the following ranges:
9186     * - 0 - 23, for hours
9187     * - 0 - 59, for minutes
9188     * - 0 - 59, for seconds,
9189     *
9190     * even if the clock is not in "military" mode.
9191     *
9192     * @warning The behavior for values set out of those ranges is @b
9193     * indefined.
9194     *
9195     * @ingroup Clock
9196     */
9197    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9198
9199    /**
9200     * Get a clock widget's time values
9201     *
9202     * @param obj The clock object
9203     * @param[out] hrs Pointer to the variable to get the hours value
9204     * @param[out] min Pointer to the variable to get the minutes value
9205     * @param[out] sec Pointer to the variable to get the seconds value
9206     *
9207     * This function gets the time set for @p obj, returning
9208     * it on the variables passed as the arguments to function
9209     *
9210     * @note Use @c NULL pointers on the time values you're not
9211     * interested in: they'll be ignored by the function.
9212     *
9213     * @ingroup Clock
9214     */
9215    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9216
9217    /**
9218     * Set whether a given clock widget is under <b>edition mode</b> or
9219     * under (default) displaying-only mode.
9220     *
9221     * @param obj The clock object
9222     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9223     * put it back to "displaying only" mode
9224     *
9225     * This function makes a clock's time to be editable or not <b>by
9226     * user interaction</b>. When in edition mode, clocks @b stop
9227     * ticking, until one brings them back to canonical mode. The
9228     * elm_clock_digit_edit_set() function will influence which digits
9229     * of the clock will be editable. By default, all of them will be
9230     * (#ELM_CLOCK_NONE).
9231     *
9232     * @note am/pm sheets, if being shown, will @b always be editable
9233     * under edition mode.
9234     *
9235     * @see elm_clock_edit_get()
9236     *
9237     * @ingroup Clock
9238     */
9239    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9240
9241    /**
9242     * Retrieve whether a given clock widget is under <b>edition
9243     * mode</b> or under (default) displaying-only mode.
9244     *
9245     * @param obj The clock object
9246     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9247     * otherwise
9248     *
9249     * This function retrieves whether the clock's time can be edited
9250     * or not by user interaction.
9251     *
9252     * @see elm_clock_edit_set() for more details
9253     *
9254     * @ingroup Clock
9255     */
9256    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9257
9258    /**
9259     * Set what digits of the given clock widget should be editable
9260     * when in edition mode.
9261     *
9262     * @param obj The clock object
9263     * @param digedit Bit mask indicating the digits to be editable
9264     * (values in #Elm_Clock_Digedit).
9265     *
9266     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9267     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9268     * EINA_FALSE).
9269     *
9270     * @see elm_clock_digit_edit_get()
9271     *
9272     * @ingroup Clock
9273     */
9274    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9275
9276    /**
9277     * Retrieve what digits of the given clock widget should be
9278     * editable when in edition mode.
9279     *
9280     * @param obj The clock object
9281     * @return Bit mask indicating the digits to be editable
9282     * (values in #Elm_Clock_Digedit).
9283     *
9284     * @see elm_clock_digit_edit_set() for more details
9285     *
9286     * @ingroup Clock
9287     */
9288    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9289
9290    /**
9291     * Set if the given clock widget must show hours in military or
9292     * am/pm mode
9293     *
9294     * @param obj The clock object
9295     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9296     * to military mode
9297     *
9298     * This function sets if the clock must show hours in military or
9299     * am/pm mode. In some countries like Brazil the military mode
9300     * (00-24h-format) is used, in opposition to the USA, where the
9301     * am/pm mode is more commonly used.
9302     *
9303     * @see elm_clock_show_am_pm_get()
9304     *
9305     * @ingroup Clock
9306     */
9307    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9308
9309    /**
9310     * Get if the given clock widget shows hours in military or am/pm
9311     * mode
9312     *
9313     * @param obj The clock object
9314     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9315     * military
9316     *
9317     * This function gets if the clock shows hours in military or am/pm
9318     * mode.
9319     *
9320     * @see elm_clock_show_am_pm_set() for more details
9321     *
9322     * @ingroup Clock
9323     */
9324    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9325
9326    /**
9327     * Set if the given clock widget must show time with seconds or not
9328     *
9329     * @param obj The clock object
9330     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9331     *
9332     * This function sets if the given clock must show or not elapsed
9333     * seconds. By default, they are @b not shown.
9334     *
9335     * @see elm_clock_show_seconds_get()
9336     *
9337     * @ingroup Clock
9338     */
9339    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9340
9341    /**
9342     * Get whether the given clock widget is showing time with seconds
9343     * or not
9344     *
9345     * @param obj The clock object
9346     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9347     *
9348     * This function gets whether @p obj is showing or not the elapsed
9349     * seconds.
9350     *
9351     * @see elm_clock_show_seconds_set()
9352     *
9353     * @ingroup Clock
9354     */
9355    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9356
9357    /**
9358     * Set the interval on time updates for an user mouse button hold
9359     * on clock widgets' time edition.
9360     *
9361     * @param obj The clock object
9362     * @param interval The (first) interval value in seconds
9363     *
9364     * This interval value is @b decreased while the user holds the
9365     * mouse pointer either incrementing or decrementing a given the
9366     * clock digit's value.
9367     *
9368     * This helps the user to get to a given time distant from the
9369     * current one easier/faster, as it will start to flip quicker and
9370     * quicker on mouse button holds.
9371     *
9372     * The calculation for the next flip interval value, starting from
9373     * the one set with this call, is the previous interval divided by
9374     * 1.05, so it decreases a little bit.
9375     *
9376     * The default starting interval value for automatic flips is
9377     * @b 0.85 seconds.
9378     *
9379     * @see elm_clock_interval_get()
9380     *
9381     * @ingroup Clock
9382     */
9383    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9384
9385    /**
9386     * Get the interval on time updates for an user mouse button hold
9387     * on clock widgets' time edition.
9388     *
9389     * @param obj The clock object
9390     * @return The (first) interval value, in seconds, set on it
9391     *
9392     * @see elm_clock_interval_set() for more details
9393     *
9394     * @ingroup Clock
9395     */
9396    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9397
9398    /**
9399     * @}
9400     */
9401
9402    /**
9403     * @defgroup Layout Layout
9404     *
9405     * @image html img/widget/layout/preview-00.png
9406     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9407     *
9408     * @image html img/layout-predefined.png
9409     * @image latex img/layout-predefined.eps width=\textwidth
9410     *
9411     * This is a container widget that takes a standard Edje design file and
9412     * wraps it very thinly in a widget.
9413     *
9414     * An Edje design (theme) file has a very wide range of possibilities to
9415     * describe the behavior of elements added to the Layout. Check out the Edje
9416     * documentation and the EDC reference to get more information about what can
9417     * be done with Edje.
9418     *
9419     * Just like @ref List, @ref Box, and other container widgets, any
9420     * object added to the Layout will become its child, meaning that it will be
9421     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9422     *
9423     * The Layout widget can contain as many Contents, Boxes or Tables as
9424     * described in its theme file. For instance, objects can be added to
9425     * different Tables by specifying the respective Table part names. The same
9426     * is valid for Content and Box.
9427     *
9428     * The objects added as child of the Layout will behave as described in the
9429     * part description where they were added. There are 3 possible types of
9430     * parts where a child can be added:
9431     *
9432     * @section secContent Content (SWALLOW part)
9433     *
9434     * Only one object can be added to the @c SWALLOW part (but you still can
9435     * have many @c SWALLOW parts and one object on each of them). Use the @c
9436     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9437     * objects as content of the @c SWALLOW. After being set to this part, the 
9438     * object size, position, visibility, clipping and other description 
9439     * properties will be totally controled by the description of the given part 
9440     * (inside the Edje theme file).
9441     *
9442     * One can use @c evas_object_size_hint_* functions on the child to have some
9443     * kind of control over its behavior, but the resulting behavior will still
9444     * depend heavily on the @c SWALLOW part description.
9445     *
9446     * The Edje theme also can change the part description, based on signals or
9447     * scripts running inside the theme. This change can also be animated. All of
9448     * this will affect the child object set as content accordingly. The object
9449     * size will be changed if the part size is changed, it will animate move if
9450     * the part is moving, and so on.
9451     *
9452     * The following picture demonstrates a Layout widget with a child object
9453     * added to its @c SWALLOW:
9454     *
9455     * @image html layout_swallow.png
9456     * @image latex layout_swallow.eps width=\textwidth
9457     *
9458     * @section secBox Box (BOX part)
9459     *
9460     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9461     * allows one to add objects to the box and have them distributed along its
9462     * area, accordingly to the specified @a layout property (now by @a layout we
9463     * mean the chosen layouting design of the Box, not the Layout widget
9464     * itself).
9465     *
9466     * A similar effect for having a box with its position, size and other things
9467     * controled by the Layout theme would be to create an Elementary @ref Box
9468     * widget and add it as a Content in the @c SWALLOW part.
9469     *
9470     * The main difference of using the Layout Box is that its behavior, the box
9471     * properties like layouting format, padding, align, etc. will be all
9472     * controled by the theme. This means, for example, that a signal could be
9473     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9474     * handled the signal by changing the box padding, or align, or both. Using
9475     * the Elementary @ref Box widget is not necessarily harder or easier, it
9476     * just depends on the circunstances and requirements.
9477     *
9478     * The Layout Box can be used through the @c elm_layout_box_* set of
9479     * functions.
9480     *
9481     * The following picture demonstrates a Layout widget with many child objects
9482     * added to its @c BOX part:
9483     *
9484     * @image html layout_box.png
9485     * @image latex layout_box.eps width=\textwidth
9486     *
9487     * @section secTable Table (TABLE part)
9488     *
9489     * Just like the @ref secBox, the Layout Table is very similar to the
9490     * Elementary @ref Table widget. It allows one to add objects to the Table
9491     * specifying the row and column where the object should be added, and any
9492     * column or row span if necessary.
9493     *
9494     * Again, we could have this design by adding a @ref Table widget to the @c
9495     * SWALLOW part using elm_object_content_part_set(). The same difference happens
9496     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9497     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9498     *
9499     * The Layout Table can be used through the @c elm_layout_table_* set of
9500     * functions.
9501     *
9502     * The following picture demonstrates a Layout widget with many child objects
9503     * added to its @c TABLE part:
9504     *
9505     * @image html layout_table.png
9506     * @image latex layout_table.eps width=\textwidth
9507     *
9508     * @section secPredef Predefined Layouts
9509     *
9510     * Another interesting thing about the Layout widget is that it offers some
9511     * predefined themes that come with the default Elementary theme. These
9512     * themes can be set by the call elm_layout_theme_set(), and provide some
9513     * basic functionality depending on the theme used.
9514     *
9515     * Most of them already send some signals, some already provide a toolbar or
9516     * back and next buttons.
9517     *
9518     * These are available predefined theme layouts. All of them have class = @c
9519     * layout, group = @c application, and style = one of the following options:
9520     *
9521     * @li @c toolbar-content - application with toolbar and main content area
9522     * @li @c toolbar-content-back - application with toolbar and main content
9523     * area with a back button and title area
9524     * @li @c toolbar-content-back-next - application with toolbar and main
9525     * content area with a back and next buttons and title area
9526     * @li @c content-back - application with a main content area with a back
9527     * button and title area
9528     * @li @c content-back-next - application with a main content area with a
9529     * back and next buttons and title area
9530     * @li @c toolbar-vbox - application with toolbar and main content area as a
9531     * vertical box
9532     * @li @c toolbar-table - application with toolbar and main content area as a
9533     * table
9534     *
9535     * @section secExamples Examples
9536     *
9537     * Some examples of the Layout widget can be found here:
9538     * @li @ref layout_example_01
9539     * @li @ref layout_example_02
9540     * @li @ref layout_example_03
9541     * @li @ref layout_example_edc
9542     *
9543     */
9544
9545    /**
9546     * Add a new layout to the parent
9547     *
9548     * @param parent The parent object
9549     * @return The new object or NULL if it cannot be created
9550     *
9551     * @see elm_layout_file_set()
9552     * @see elm_layout_theme_set()
9553     *
9554     * @ingroup Layout
9555     */
9556    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9557    /**
9558     * Set the file that will be used as layout
9559     *
9560     * @param obj The layout object
9561     * @param file The path to file (edj) that will be used as layout
9562     * @param group The group that the layout belongs in edje file
9563     *
9564     * @return (1 = success, 0 = error)
9565     *
9566     * @ingroup Layout
9567     */
9568    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9569    /**
9570     * Set the edje group from the elementary theme that will be used as layout
9571     *
9572     * @param obj The layout object
9573     * @param clas the clas of the group
9574     * @param group the group
9575     * @param style the style to used
9576     *
9577     * @return (1 = success, 0 = error)
9578     *
9579     * @ingroup Layout
9580     */
9581    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9582    /**
9583     * Set the layout content.
9584     *
9585     * @param obj The layout object
9586     * @param swallow The swallow part name in the edje file
9587     * @param content The child that will be added in this layout object
9588     *
9589     * Once the content object is set, a previously set one will be deleted.
9590     * If you want to keep that old content object, use the
9591     * elm_object_content_part_unset() function.
9592     *
9593     * @note In an Edje theme, the part used as a content container is called @c
9594     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9595     * expected to be a part name just like the second parameter of
9596     * elm_layout_box_append().
9597     *
9598     * @see elm_layout_box_append()
9599     * @see elm_object_content_part_get()
9600     * @see elm_object_content_part_unset()
9601     * @see @ref secBox
9602     *
9603     * @ingroup Layout
9604     */
9605    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9606    /**
9607     * Get the child object in the given content part.
9608     *
9609     * @param obj The layout object
9610     * @param swallow The SWALLOW part to get its content
9611     *
9612     * @return The swallowed object or NULL if none or an error occurred
9613     *
9614     * @see elm_object_content_part_set()
9615     *
9616     * @ingroup Layout
9617     */
9618    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9619    /**
9620     * Unset the layout content.
9621     *
9622     * @param obj The layout object
9623     * @param swallow The swallow part name in the edje file
9624     * @return The content that was being used
9625     *
9626     * Unparent and return the content object which was set for this part.
9627     *
9628     * @see elm_object_content_part_set()
9629     *
9630     * @ingroup Layout
9631     */
9632    EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9633    /**
9634     * Set the text of the given part
9635     *
9636     * @param obj The layout object
9637     * @param part The TEXT part where to set the text
9638     * @param text The text to set
9639     *
9640     * @ingroup Layout
9641     * @deprecated use elm_object_text_* instead.
9642     */
9643    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9644    /**
9645     * Get the text set in the given part
9646     *
9647     * @param obj The layout object
9648     * @param part The TEXT part to retrieve the text off
9649     *
9650     * @return The text set in @p part
9651     *
9652     * @ingroup Layout
9653     * @deprecated use elm_object_text_* instead.
9654     */
9655    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9656    /**
9657     * Append child to layout box part.
9658     *
9659     * @param obj the layout object
9660     * @param part the box part to which the object will be appended.
9661     * @param child the child object to append to box.
9662     *
9663     * Once the object is appended, it will become child of the layout. Its
9664     * lifetime will be bound to the layout, whenever the layout dies the child
9665     * will be deleted automatically. One should use elm_layout_box_remove() to
9666     * make this layout forget about the object.
9667     *
9668     * @see elm_layout_box_prepend()
9669     * @see elm_layout_box_insert_before()
9670     * @see elm_layout_box_insert_at()
9671     * @see elm_layout_box_remove()
9672     *
9673     * @ingroup Layout
9674     */
9675    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9676    /**
9677     * Prepend child to layout box part.
9678     *
9679     * @param obj the layout object
9680     * @param part the box part to prepend.
9681     * @param child the child object to prepend to box.
9682     *
9683     * Once the object is prepended, it will become child of the layout. Its
9684     * lifetime will be bound to the layout, whenever the layout dies the child
9685     * will be deleted automatically. One should use elm_layout_box_remove() to
9686     * make this layout forget about the object.
9687     *
9688     * @see elm_layout_box_append()
9689     * @see elm_layout_box_insert_before()
9690     * @see elm_layout_box_insert_at()
9691     * @see elm_layout_box_remove()
9692     *
9693     * @ingroup Layout
9694     */
9695    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9696    /**
9697     * Insert child to layout box part before a reference object.
9698     *
9699     * @param obj the layout object
9700     * @param part the box part to insert.
9701     * @param child the child object to insert into box.
9702     * @param reference another reference object to insert before in box.
9703     *
9704     * Once the object is inserted, it will become child of the layout. Its
9705     * lifetime will be bound to the layout, whenever the layout dies the child
9706     * will be deleted automatically. One should use elm_layout_box_remove() to
9707     * make this layout forget about the object.
9708     *
9709     * @see elm_layout_box_append()
9710     * @see elm_layout_box_prepend()
9711     * @see elm_layout_box_insert_before()
9712     * @see elm_layout_box_remove()
9713     *
9714     * @ingroup Layout
9715     */
9716    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9717    /**
9718     * Insert child to layout box part at a given position.
9719     *
9720     * @param obj the layout object
9721     * @param part the box part to insert.
9722     * @param child the child object to insert into box.
9723     * @param pos the numeric position >=0 to insert the child.
9724     *
9725     * Once the object is inserted, it will become child of the layout. Its
9726     * lifetime will be bound to the layout, whenever the layout dies the child
9727     * will be deleted automatically. One should use elm_layout_box_remove() to
9728     * make this layout forget about the object.
9729     *
9730     * @see elm_layout_box_append()
9731     * @see elm_layout_box_prepend()
9732     * @see elm_layout_box_insert_before()
9733     * @see elm_layout_box_remove()
9734     *
9735     * @ingroup Layout
9736     */
9737    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9738    /**
9739     * Remove a child of the given part box.
9740     *
9741     * @param obj The layout object
9742     * @param part The box part name to remove child.
9743     * @param child The object to remove from box.
9744     * @return The object that was being used, or NULL if not found.
9745     *
9746     * The object will be removed from the box part and its lifetime will
9747     * not be handled by the layout anymore. This is equivalent to
9748     * elm_object_content_part_unset() for box.
9749     *
9750     * @see elm_layout_box_append()
9751     * @see elm_layout_box_remove_all()
9752     *
9753     * @ingroup Layout
9754     */
9755    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9756    /**
9757     * Remove all child of the given part box.
9758     *
9759     * @param obj The layout object
9760     * @param part The box part name to remove child.
9761     * @param clear If EINA_TRUE, then all objects will be deleted as
9762     *        well, otherwise they will just be removed and will be
9763     *        dangling on the canvas.
9764     *
9765     * The objects will be removed from the box part and their lifetime will
9766     * not be handled by the layout anymore. This is equivalent to
9767     * elm_layout_box_remove() for all box children.
9768     *
9769     * @see elm_layout_box_append()
9770     * @see elm_layout_box_remove()
9771     *
9772     * @ingroup Layout
9773     */
9774    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9775    /**
9776     * Insert child to layout table part.
9777     *
9778     * @param obj the layout object
9779     * @param part the box part to pack child.
9780     * @param child_obj the child object to pack into table.
9781     * @param col the column to which the child should be added. (>= 0)
9782     * @param row the row to which the child should be added. (>= 0)
9783     * @param colspan how many columns should be used to store this object. (>=
9784     *        1)
9785     * @param rowspan how many rows should be used to store this object. (>= 1)
9786     *
9787     * Once the object is inserted, it will become child of the table. Its
9788     * lifetime will be bound to the layout, and whenever the layout dies the
9789     * child will be deleted automatically. One should use
9790     * elm_layout_table_remove() to make this layout forget about the object.
9791     *
9792     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9793     * more space than a single cell. For instance, the following code:
9794     * @code
9795     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9796     * @endcode
9797     *
9798     * Would result in an object being added like the following picture:
9799     *
9800     * @image html layout_colspan.png
9801     * @image latex layout_colspan.eps width=\textwidth
9802     *
9803     * @see elm_layout_table_unpack()
9804     * @see elm_layout_table_clear()
9805     *
9806     * @ingroup Layout
9807     */
9808    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);
9809    /**
9810     * Unpack (remove) a child of the given part table.
9811     *
9812     * @param obj The layout object
9813     * @param part The table part name to remove child.
9814     * @param child_obj The object to remove from table.
9815     * @return The object that was being used, or NULL if not found.
9816     *
9817     * The object will be unpacked from the table part and its lifetime
9818     * will not be handled by the layout anymore. This is equivalent to
9819     * elm_object_content_part_unset() for table.
9820     *
9821     * @see elm_layout_table_pack()
9822     * @see elm_layout_table_clear()
9823     *
9824     * @ingroup Layout
9825     */
9826    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9827    /**
9828     * Remove all child of the given part table.
9829     *
9830     * @param obj The layout object
9831     * @param part The table part name to remove child.
9832     * @param clear If EINA_TRUE, then all objects will be deleted as
9833     *        well, otherwise they will just be removed and will be
9834     *        dangling on the canvas.
9835     *
9836     * The objects will be removed from the table part and their lifetime will
9837     * not be handled by the layout anymore. This is equivalent to
9838     * elm_layout_table_unpack() for all table children.
9839     *
9840     * @see elm_layout_table_pack()
9841     * @see elm_layout_table_unpack()
9842     *
9843     * @ingroup Layout
9844     */
9845    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9846    /**
9847     * Get the edje layout
9848     *
9849     * @param obj The layout object
9850     *
9851     * @return A Evas_Object with the edje layout settings loaded
9852     * with function elm_layout_file_set
9853     *
9854     * This returns the edje object. It is not expected to be used to then
9855     * swallow objects via edje_object_part_swallow() for example. Use
9856     * elm_object_content_part_set() instead so child object handling and sizing is
9857     * done properly.
9858     *
9859     * @note This function should only be used if you really need to call some
9860     * low level Edje function on this edje object. All the common stuff (setting
9861     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9862     * with proper elementary functions.
9863     *
9864     * @see elm_object_signal_callback_add()
9865     * @see elm_object_signal_emit()
9866     * @see elm_object_text_part_set()
9867     * @see elm_object_content_part_set()
9868     * @see elm_layout_box_append()
9869     * @see elm_layout_table_pack()
9870     * @see elm_layout_data_get()
9871     *
9872     * @ingroup Layout
9873     */
9874    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9875    /**
9876     * Get the edje data from the given layout
9877     *
9878     * @param obj The layout object
9879     * @param key The data key
9880     *
9881     * @return The edje data string
9882     *
9883     * This function fetches data specified inside the edje theme of this layout.
9884     * This function return NULL if data is not found.
9885     *
9886     * In EDC this comes from a data block within the group block that @p
9887     * obj was loaded from. E.g.
9888     *
9889     * @code
9890     * collections {
9891     *   group {
9892     *     name: "a_group";
9893     *     data {
9894     *       item: "key1" "value1";
9895     *       item: "key2" "value2";
9896     *     }
9897     *   }
9898     * }
9899     * @endcode
9900     *
9901     * @ingroup Layout
9902     */
9903    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9904    /**
9905     * Eval sizing
9906     *
9907     * @param obj The layout object
9908     *
9909     * Manually forces a sizing re-evaluation. This is useful when the minimum
9910     * size required by the edje theme of this layout has changed. The change on
9911     * the minimum size required by the edje theme is not immediately reported to
9912     * the elementary layout, so one needs to call this function in order to tell
9913     * the widget (layout) that it needs to reevaluate its own size.
9914     *
9915     * The minimum size of the theme is calculated based on minimum size of
9916     * parts, the size of elements inside containers like box and table, etc. All
9917     * of this can change due to state changes, and that's when this function
9918     * should be called.
9919     *
9920     * Also note that a standard signal of "size,eval" "elm" emitted from the
9921     * edje object will cause this to happen too.
9922     *
9923     * @ingroup Layout
9924     */
9925    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9926
9927    /**
9928     * Sets a specific cursor for an edje part.
9929     *
9930     * @param obj The layout object.
9931     * @param part_name a part from loaded edje group.
9932     * @param cursor cursor name to use, see Elementary_Cursor.h
9933     *
9934     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9935     *         part not exists or it has "mouse_events: 0".
9936     *
9937     * @ingroup Layout
9938     */
9939    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9940
9941    /**
9942     * Get the cursor to be shown when mouse is over an edje part
9943     *
9944     * @param obj The layout object.
9945     * @param part_name a part from loaded edje group.
9946     * @return the cursor name.
9947     *
9948     * @ingroup Layout
9949     */
9950    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9951
9952    /**
9953     * Unsets a cursor previously set with elm_layout_part_cursor_set().
9954     *
9955     * @param obj The layout object.
9956     * @param part_name a part from loaded edje group, that had a cursor set
9957     *        with elm_layout_part_cursor_set().
9958     *
9959     * @ingroup Layout
9960     */
9961    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9962
9963    /**
9964     * Sets a specific cursor style for an edje part.
9965     *
9966     * @param obj The layout object.
9967     * @param part_name a part from loaded edje group.
9968     * @param style the theme style to use (default, transparent, ...)
9969     *
9970     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9971     *         part not exists or it did not had a cursor set.
9972     *
9973     * @ingroup Layout
9974     */
9975    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9976
9977    /**
9978     * Gets a specific cursor style for an edje part.
9979     *
9980     * @param obj The layout object.
9981     * @param part_name a part from loaded edje group.
9982     *
9983     * @return the theme style in use, defaults to "default". If the
9984     *         object does not have a cursor set, then NULL is returned.
9985     *
9986     * @ingroup Layout
9987     */
9988    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9989
9990    /**
9991     * Sets if the cursor set should be searched on the theme or should use
9992     * the provided by the engine, only.
9993     *
9994     * @note before you set if should look on theme you should define a
9995     * cursor with elm_layout_part_cursor_set(). By default it will only
9996     * look for cursors provided by the engine.
9997     *
9998     * @param obj The layout object.
9999     * @param part_name a part from loaded edje group.
10000     * @param engine_only if cursors should be just provided by the engine
10001     *        or should also search on widget's theme as well
10002     *
10003     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10004     *         part not exists or it did not had a cursor set.
10005     *
10006     * @ingroup Layout
10007     */
10008    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);
10009
10010    /**
10011     * Gets a specific cursor engine_only for an edje part.
10012     *
10013     * @param obj The layout object.
10014     * @param part_name a part from loaded edje group.
10015     *
10016     * @return whenever the cursor is just provided by engine or also from theme.
10017     *
10018     * @ingroup Layout
10019     */
10020    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10021
10022 /**
10023  * @def elm_layout_icon_set
10024  * Convienience macro to set the icon object in a layout that follows the
10025  * Elementary naming convention for its parts.
10026  *
10027  * @ingroup Layout
10028  */
10029 #define elm_layout_icon_set(_ly, _obj) \
10030   do { \
10031     const char *sig; \
10032     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10033     if ((_obj)) sig = "elm,state,icon,visible"; \
10034     else sig = "elm,state,icon,hidden"; \
10035     elm_object_signal_emit((_ly), sig, "elm"); \
10036   } while (0)
10037
10038 /**
10039  * @def elm_layout_icon_get
10040  * Convienience macro to get the icon object from a layout that follows the
10041  * Elementary naming convention for its parts.
10042  *
10043  * @ingroup Layout
10044  */
10045 #define elm_layout_icon_get(_ly) \
10046   elm_layout_content_get((_ly), "elm.swallow.icon")
10047
10048 /**
10049  * @def elm_layout_end_set
10050  * Convienience macro to set the end object in a layout that follows the
10051  * Elementary naming convention for its parts.
10052  *
10053  * @ingroup Layout
10054  */
10055 #define elm_layout_end_set(_ly, _obj) \
10056   do { \
10057     const char *sig; \
10058     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10059     if ((_obj)) sig = "elm,state,end,visible"; \
10060     else sig = "elm,state,end,hidden"; \
10061     elm_object_signal_emit((_ly), sig, "elm"); \
10062   } while (0)
10063
10064 /**
10065  * @def elm_layout_end_get
10066  * Convienience macro to get the end object in a layout that follows the
10067  * Elementary naming convention for its parts.
10068  *
10069  * @ingroup Layout
10070  */
10071 #define elm_layout_end_get(_ly) \
10072   elm_layout_content_get((_ly), "elm.swallow.end")
10073
10074 /**
10075  * @def elm_layout_label_set
10076  * Convienience macro to set the label in a layout that follows the
10077  * Elementary naming convention for its parts.
10078  *
10079  * @ingroup Layout
10080  * @deprecated use elm_object_text_* instead.
10081  */
10082 #define elm_layout_label_set(_ly, _txt) \
10083   elm_layout_text_set((_ly), "elm.text", (_txt))
10084
10085 /**
10086  * @def elm_layout_label_get
10087  * Convenience macro to get the label in a layout that follows the
10088  * Elementary naming convention for its parts.
10089  *
10090  * @ingroup Layout
10091  * @deprecated use elm_object_text_* instead.
10092  */
10093 #define elm_layout_label_get(_ly) \
10094   elm_layout_text_get((_ly), "elm.text")
10095
10096    /* smart callbacks called:
10097     * "theme,changed" - when elm theme is changed.
10098     */
10099
10100    /**
10101     * @defgroup Notify Notify
10102     *
10103     * @image html img/widget/notify/preview-00.png
10104     * @image latex img/widget/notify/preview-00.eps
10105     *
10106     * Display a container in a particular region of the parent(top, bottom,
10107     * etc).  A timeout can be set to automatically hide the notify. This is so
10108     * that, after an evas_object_show() on a notify object, if a timeout was set
10109     * on it, it will @b automatically get hidden after that time.
10110     *
10111     * Signals that you can add callbacks for are:
10112     * @li "timeout" - when timeout happens on notify and it's hidden
10113     * @li "block,clicked" - when a click outside of the notify happens
10114     *
10115     * Default contents parts of the notify widget that you can use for are:
10116     * @li "elm.swallow.content" - A content of the notify
10117     *
10118     * @ref tutorial_notify show usage of the API.
10119     *
10120     * @{
10121     */
10122    /**
10123     * @brief Possible orient values for notify.
10124     *
10125     * This values should be used in conjunction to elm_notify_orient_set() to
10126     * set the position in which the notify should appear(relative to its parent)
10127     * and in conjunction with elm_notify_orient_get() to know where the notify
10128     * is appearing.
10129     */
10130    typedef enum _Elm_Notify_Orient
10131      {
10132         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10133         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10134         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10135         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10136         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10137         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10138         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10139         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10140         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10141         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10142      } Elm_Notify_Orient;
10143    /**
10144     * @brief Add a new notify to the parent
10145     *
10146     * @param parent The parent object
10147     * @return The new object or NULL if it cannot be created
10148     */
10149    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10150    /**
10151     * @brief Set the content of the notify widget
10152     *
10153     * @param obj The notify object
10154     * @param content The content will be filled in this notify object
10155     *
10156     * Once the content object is set, a previously set one will be deleted. If
10157     * you want to keep that old content object, use the
10158     * elm_notify_content_unset() function.
10159     */
10160    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10161    /**
10162     * @brief Unset the content of the notify widget
10163     *
10164     * @param obj The notify object
10165     * @return The content that was being used
10166     *
10167     * Unparent and return the content object which was set for this widget
10168     *
10169     * @see elm_notify_content_set()
10170     */
10171    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10172    /**
10173     * @brief Return the content of the notify widget
10174     *
10175     * @param obj The notify object
10176     * @return The content that is being used
10177     *
10178     * @see elm_notify_content_set()
10179     */
10180    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10181    /**
10182     * @brief Set the notify parent
10183     *
10184     * @param obj The notify object
10185     * @param content The new parent
10186     *
10187     * Once the parent object is set, a previously set one will be disconnected
10188     * and replaced.
10189     */
10190    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10191    /**
10192     * @brief Get the notify parent
10193     *
10194     * @param obj The notify object
10195     * @return The parent
10196     *
10197     * @see elm_notify_parent_set()
10198     */
10199    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10200    /**
10201     * @brief Set the orientation
10202     *
10203     * @param obj The notify object
10204     * @param orient The new orientation
10205     *
10206     * Sets the position in which the notify will appear in its parent.
10207     *
10208     * @see @ref Elm_Notify_Orient for possible values.
10209     */
10210    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10211    /**
10212     * @brief Return the orientation
10213     * @param obj The notify object
10214     * @return The orientation of the notification
10215     *
10216     * @see elm_notify_orient_set()
10217     * @see Elm_Notify_Orient
10218     */
10219    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10220    /**
10221     * @brief Set the time interval after which the notify window is going to be
10222     * hidden.
10223     *
10224     * @param obj The notify object
10225     * @param time The timeout in seconds
10226     *
10227     * This function sets a timeout and starts the timer controlling when the
10228     * notify is hidden. Since calling evas_object_show() on a notify restarts
10229     * the timer controlling when the notify is hidden, setting this before the
10230     * notify is shown will in effect mean starting the timer when the notify is
10231     * shown.
10232     *
10233     * @note Set a value <= 0.0 to disable a running timer.
10234     *
10235     * @note If the value > 0.0 and the notify is previously visible, the
10236     * timer will be started with this value, canceling any running timer.
10237     */
10238    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10239    /**
10240     * @brief Return the timeout value (in seconds)
10241     * @param obj the notify object
10242     *
10243     * @see elm_notify_timeout_set()
10244     */
10245    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10246    /**
10247     * @brief Sets whether events should be passed to by a click outside
10248     * its area.
10249     *
10250     * @param obj The notify object
10251     * @param repeats EINA_TRUE Events are repeats, else no
10252     *
10253     * When true if the user clicks outside the window the events will be caught
10254     * by the others widgets, else the events are blocked.
10255     *
10256     * @note The default value is EINA_TRUE.
10257     */
10258    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10259    /**
10260     * @brief Return true if events are repeat below the notify object
10261     * @param obj the notify object
10262     *
10263     * @see elm_notify_repeat_events_set()
10264     */
10265    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10266    /**
10267     * @}
10268     */
10269
10270    /**
10271     * @defgroup Hover Hover
10272     *
10273     * @image html img/widget/hover/preview-00.png
10274     * @image latex img/widget/hover/preview-00.eps
10275     *
10276     * A Hover object will hover over its @p parent object at the @p target
10277     * location. Anything in the background will be given a darker coloring to
10278     * indicate that the hover object is on top (at the default theme). When the
10279     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10280     * clicked that @b doesn't cause the hover to be dismissed.
10281     *
10282     * A Hover object has two parents. One parent that owns it during creation
10283     * and the other parent being the one over which the hover object spans.
10284     *
10285     *
10286     * @note The hover object will take up the entire space of @p target
10287     * object.
10288     *
10289     * Elementary has the following styles for the hover widget:
10290     * @li default
10291     * @li popout
10292     * @li menu
10293     * @li hoversel_vertical
10294     *
10295     * The following are the available position for content:
10296     * @li left
10297     * @li top-left
10298     * @li top
10299     * @li top-right
10300     * @li right
10301     * @li bottom-right
10302     * @li bottom
10303     * @li bottom-left
10304     * @li middle
10305     * @li smart
10306     *
10307     * Signals that you can add callbacks for are:
10308     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10309     * @li "smart,changed" - a content object placed under the "smart"
10310     *                   policy was replaced to a new slot direction.
10311     *
10312     * See @ref tutorial_hover for more information.
10313     *
10314     * @{
10315     */
10316    typedef enum _Elm_Hover_Axis
10317      {
10318         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10319         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10320         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10321         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10322      } Elm_Hover_Axis;
10323    /**
10324     * @brief Adds a hover object to @p parent
10325     *
10326     * @param parent The parent object
10327     * @return The hover object or NULL if one could not be created
10328     */
10329    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10330    /**
10331     * @brief Sets the target object for the hover.
10332     *
10333     * @param obj The hover object
10334     * @param target The object to center the hover onto. The hover
10335     *
10336     * This function will cause the hover to be centered on the target object.
10337     */
10338    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10339    /**
10340     * @brief Gets the target object for the hover.
10341     *
10342     * @param obj The hover object
10343     * @param parent The object to locate the hover over.
10344     *
10345     * @see elm_hover_target_set()
10346     */
10347    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10348    /**
10349     * @brief Sets the parent object for the hover.
10350     *
10351     * @param obj The hover object
10352     * @param parent The object to locate the hover over.
10353     *
10354     * This function will cause the hover to take up the entire space that the
10355     * parent object fills.
10356     */
10357    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10358    /**
10359     * @brief Gets the parent object for the hover.
10360     *
10361     * @param obj The hover object
10362     * @return The parent object to locate the hover over.
10363     *
10364     * @see elm_hover_parent_set()
10365     */
10366    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10367    /**
10368     * @brief Sets the content of the hover object and the direction in which it
10369     * will pop out.
10370     *
10371     * @param obj The hover object
10372     * @param swallow The direction that the object will be displayed
10373     * at. Accepted values are "left", "top-left", "top", "top-right",
10374     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10375     * "smart".
10376     * @param content The content to place at @p swallow
10377     *
10378     * Once the content object is set for a given direction, a previously
10379     * set one (on the same direction) will be deleted. If you want to
10380     * keep that old content object, use the elm_hover_content_unset()
10381     * function.
10382     *
10383     * All directions may have contents at the same time, except for
10384     * "smart". This is a special placement hint and its use case
10385     * independs of the calculations coming from
10386     * elm_hover_best_content_location_get(). Its use is for cases when
10387     * one desires only one hover content, but with a dinamic special
10388     * placement within the hover area. The content's geometry, whenever
10389     * it changes, will be used to decide on a best location not
10390     * extrapolating the hover's parent object view to show it in (still
10391     * being the hover's target determinant of its medium part -- move and
10392     * resize it to simulate finger sizes, for example). If one of the
10393     * directions other than "smart" are used, a previously content set
10394     * using it will be deleted, and vice-versa.
10395     */
10396    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10397    /**
10398     * @brief Get the content of the hover object, in a given direction.
10399     *
10400     * Return the content object which was set for this widget in the
10401     * @p swallow direction.
10402     *
10403     * @param obj The hover object
10404     * @param swallow The direction that the object was display at.
10405     * @return The content that was being used
10406     *
10407     * @see elm_hover_content_set()
10408     */
10409    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10410    /**
10411     * @brief Unset the content of the hover object, in a given direction.
10412     *
10413     * Unparent and return the content object set at @p swallow direction.
10414     *
10415     * @param obj The hover object
10416     * @param swallow The direction that the object was display at.
10417     * @return The content that was being used.
10418     *
10419     * @see elm_hover_content_set()
10420     */
10421    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10422    /**
10423     * @brief Returns the best swallow location for content in the hover.
10424     *
10425     * @param obj The hover object
10426     * @param pref_axis The preferred orientation axis for the hover object to use
10427     * @return The edje location to place content into the hover or @c
10428     *         NULL, on errors.
10429     *
10430     * Best is defined here as the location at which there is the most available
10431     * space.
10432     *
10433     * @p pref_axis may be one of
10434     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10435     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10436     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10437     * - @c ELM_HOVER_AXIS_BOTH -- both
10438     *
10439     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10440     * nescessarily be along the horizontal axis("left" or "right"). If
10441     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10442     * be along the vertical axis("top" or "bottom"). Chossing
10443     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10444     * returned position may be in either axis.
10445     *
10446     * @see elm_hover_content_set()
10447     */
10448    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10449    /**
10450     * @}
10451     */
10452
10453    /* entry */
10454    /**
10455     * @defgroup Entry Entry
10456     *
10457     * @image html img/widget/entry/preview-00.png
10458     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10459     * @image html img/widget/entry/preview-01.png
10460     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10461     * @image html img/widget/entry/preview-02.png
10462     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10463     * @image html img/widget/entry/preview-03.png
10464     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10465     *
10466     * An entry is a convenience widget which shows a box that the user can
10467     * enter text into. Entries by default don't scroll, so they grow to
10468     * accomodate the entire text, resizing the parent window as needed. This
10469     * can be changed with the elm_entry_scrollable_set() function.
10470     *
10471     * They can also be single line or multi line (the default) and when set
10472     * to multi line mode they support text wrapping in any of the modes
10473     * indicated by #Elm_Wrap_Type.
10474     *
10475     * Other features include password mode, filtering of inserted text with
10476     * elm_entry_text_filter_append() and related functions, inline "items" and
10477     * formatted markup text.
10478     *
10479     * @section entry-markup Formatted text
10480     *
10481     * The markup tags supported by the Entry are defined by the theme, but
10482     * even when writing new themes or extensions it's a good idea to stick to
10483     * a sane default, to maintain coherency and avoid application breakages.
10484     * Currently defined by the default theme are the following tags:
10485     * @li \<br\>: Inserts a line break.
10486     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10487     * breaks.
10488     * @li \<tab\>: Inserts a tab.
10489     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10490     * enclosed text.
10491     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10492     * @li \<link\>...\</link\>: Underlines the enclosed text.
10493     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10494     *
10495     * @section entry-special Special markups
10496     *
10497     * Besides those used to format text, entries support two special markup
10498     * tags used to insert clickable portions of text or items inlined within
10499     * the text.
10500     *
10501     * @subsection entry-anchors Anchors
10502     *
10503     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10504     * \</a\> tags and an event will be generated when this text is clicked,
10505     * like this:
10506     *
10507     * @code
10508     * This text is outside <a href=anc-01>but this one is an anchor</a>
10509     * @endcode
10510     *
10511     * The @c href attribute in the opening tag gives the name that will be
10512     * used to identify the anchor and it can be any valid utf8 string.
10513     *
10514     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10515     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10516     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10517     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10518     * an anchor.
10519     *
10520     * @subsection entry-items Items
10521     *
10522     * Inlined in the text, any other @c Evas_Object can be inserted by using
10523     * \<item\> tags this way:
10524     *
10525     * @code
10526     * <item size=16x16 vsize=full href=emoticon/haha></item>
10527     * @endcode
10528     *
10529     * Just like with anchors, the @c href identifies each item, but these need,
10530     * in addition, to indicate their size, which is done using any one of
10531     * @c size, @c absize or @c relsize attributes. These attributes take their
10532     * value in the WxH format, where W is the width and H the height of the
10533     * item.
10534     *
10535     * @li absize: Absolute pixel size for the item. Whatever value is set will
10536     * be the item's size regardless of any scale value the object may have
10537     * been set to. The final line height will be adjusted to fit larger items.
10538     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10539     * for the object.
10540     * @li relsize: Size is adjusted for the item to fit within the current
10541     * line height.
10542     *
10543     * Besides their size, items are specificed a @c vsize value that affects
10544     * how their final size and position are calculated. The possible values
10545     * are:
10546     * @li ascent: Item will be placed within the line's baseline and its
10547     * ascent. That is, the height between the line where all characters are
10548     * positioned and the highest point in the line. For @c size and @c absize
10549     * items, the descent value will be added to the total line height to make
10550     * them fit. @c relsize items will be adjusted to fit within this space.
10551     * @li full: Items will be placed between the descent and ascent, or the
10552     * lowest point in the line and its highest.
10553     *
10554     * The next image shows different configurations of items and how they
10555     * are the previously mentioned options affect their sizes. In all cases,
10556     * the green line indicates the ascent, blue for the baseline and red for
10557     * the descent.
10558     *
10559     * @image html entry_item.png
10560     * @image latex entry_item.eps width=\textwidth
10561     *
10562     * And another one to show how size differs from absize. In the first one,
10563     * the scale value is set to 1.0, while the second one is using one of 2.0.
10564     *
10565     * @image html entry_item_scale.png
10566     * @image latex entry_item_scale.eps width=\textwidth
10567     *
10568     * After the size for an item is calculated, the entry will request an
10569     * object to place in its space. For this, the functions set with
10570     * elm_entry_item_provider_append() and related functions will be called
10571     * in order until one of them returns a @c non-NULL value. If no providers
10572     * are available, or all of them return @c NULL, then the entry falls back
10573     * to one of the internal defaults, provided the name matches with one of
10574     * them.
10575     *
10576     * All of the following are currently supported:
10577     *
10578     * - emoticon/angry
10579     * - emoticon/angry-shout
10580     * - emoticon/crazy-laugh
10581     * - emoticon/evil-laugh
10582     * - emoticon/evil
10583     * - emoticon/goggle-smile
10584     * - emoticon/grumpy
10585     * - emoticon/grumpy-smile
10586     * - emoticon/guilty
10587     * - emoticon/guilty-smile
10588     * - emoticon/haha
10589     * - emoticon/half-smile
10590     * - emoticon/happy-panting
10591     * - emoticon/happy
10592     * - emoticon/indifferent
10593     * - emoticon/kiss
10594     * - emoticon/knowing-grin
10595     * - emoticon/laugh
10596     * - emoticon/little-bit-sorry
10597     * - emoticon/love-lots
10598     * - emoticon/love
10599     * - emoticon/minimal-smile
10600     * - emoticon/not-happy
10601     * - emoticon/not-impressed
10602     * - emoticon/omg
10603     * - emoticon/opensmile
10604     * - emoticon/smile
10605     * - emoticon/sorry
10606     * - emoticon/squint-laugh
10607     * - emoticon/surprised
10608     * - emoticon/suspicious
10609     * - emoticon/tongue-dangling
10610     * - emoticon/tongue-poke
10611     * - emoticon/uh
10612     * - emoticon/unhappy
10613     * - emoticon/very-sorry
10614     * - emoticon/what
10615     * - emoticon/wink
10616     * - emoticon/worried
10617     * - emoticon/wtf
10618     *
10619     * Alternatively, an item may reference an image by its path, using
10620     * the URI form @c file:///path/to/an/image.png and the entry will then
10621     * use that image for the item.
10622     *
10623     * @section entry-files Loading and saving files
10624     *
10625     * Entries have convinience functions to load text from a file and save
10626     * changes back to it after a short delay. The automatic saving is enabled
10627     * by default, but can be disabled with elm_entry_autosave_set() and files
10628     * can be loaded directly as plain text or have any markup in them
10629     * recognized. See elm_entry_file_set() for more details.
10630     *
10631     * @section entry-signals Emitted signals
10632     *
10633     * This widget emits the following signals:
10634     *
10635     * @li "changed": The text within the entry was changed.
10636     * @li "changed,user": The text within the entry was changed because of user interaction.
10637     * @li "activated": The enter key was pressed on a single line entry.
10638     * @li "press": A mouse button has been pressed on the entry.
10639     * @li "longpressed": A mouse button has been pressed and held for a couple
10640     * seconds.
10641     * @li "clicked": The entry has been clicked (mouse press and release).
10642     * @li "clicked,double": The entry has been double clicked.
10643     * @li "clicked,triple": The entry has been triple clicked.
10644     * @li "focused": The entry has received focus.
10645     * @li "unfocused": The entry has lost focus.
10646     * @li "selection,paste": A paste of the clipboard contents was requested.
10647     * @li "selection,copy": A copy of the selected text into the clipboard was
10648     * requested.
10649     * @li "selection,cut": A cut of the selected text into the clipboard was
10650     * requested.
10651     * @li "selection,start": A selection has begun and no previous selection
10652     * existed.
10653     * @li "selection,changed": The current selection has changed.
10654     * @li "selection,cleared": The current selection has been cleared.
10655     * @li "cursor,changed": The cursor has changed position.
10656     * @li "anchor,clicked": An anchor has been clicked. The event_info
10657     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10658     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10659     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10660     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10661     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10662     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10663     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10664     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10665     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10666     * @li "preedit,changed": The preedit string has changed.
10667     * @li "language,changed": Program language changed.
10668     *
10669     * @section entry-examples
10670     *
10671     * An overview of the Entry API can be seen in @ref entry_example_01
10672     *
10673     * @{
10674     */
10675    /**
10676     * @typedef Elm_Entry_Anchor_Info
10677     *
10678     * The info sent in the callback for the "anchor,clicked" signals emitted
10679     * by entries.
10680     */
10681    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10682    /**
10683     * @struct _Elm_Entry_Anchor_Info
10684     *
10685     * The info sent in the callback for the "anchor,clicked" signals emitted
10686     * by entries.
10687     */
10688    struct _Elm_Entry_Anchor_Info
10689      {
10690         const char *name; /**< The name of the anchor, as stated in its href */
10691         int         button; /**< The mouse button used to click on it */
10692         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10693                     y, /**< Anchor geometry, relative to canvas */
10694                     w, /**< Anchor geometry, relative to canvas */
10695                     h; /**< Anchor geometry, relative to canvas */
10696      };
10697    /**
10698     * @typedef Elm_Entry_Filter_Cb
10699     * This callback type is used by entry filters to modify text.
10700     * @param data The data specified as the last param when adding the filter
10701     * @param entry The entry object
10702     * @param text A pointer to the location of the text being filtered. This data can be modified,
10703     * but any additional allocations must be managed by the user.
10704     * @see elm_entry_text_filter_append
10705     * @see elm_entry_text_filter_prepend
10706     */
10707    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10708
10709    /**
10710     * This adds an entry to @p parent object.
10711     *
10712     * By default, entries are:
10713     * @li not scrolled
10714     * @li multi-line
10715     * @li word wrapped
10716     * @li autosave is enabled
10717     *
10718     * @param parent The parent object
10719     * @return The new object or NULL if it cannot be created
10720     */
10721    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10722    /**
10723     * Sets the entry to single line mode.
10724     *
10725     * In single line mode, entries don't ever wrap when the text reaches the
10726     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10727     * key will generate an @c "activate" event instead of adding a new line.
10728     *
10729     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10730     * and pressing enter will break the text into a different line
10731     * without generating any events.
10732     *
10733     * @param obj The entry object
10734     * @param single_line If true, the text in the entry
10735     * will be on a single line.
10736     */
10737    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10738    /**
10739     * Gets whether the entry is set to be single line.
10740     *
10741     * @param obj The entry object
10742     * @return single_line If true, the text in the entry is set to display
10743     * on a single line.
10744     *
10745     * @see elm_entry_single_line_set()
10746     */
10747    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10748    /**
10749     * Sets the entry to password mode.
10750     *
10751     * In password mode, entries are implicitly single line and the display of
10752     * any text in them is replaced with asterisks (*).
10753     *
10754     * @param obj The entry object
10755     * @param password If true, password mode is enabled.
10756     */
10757    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10758    /**
10759     * Gets whether the entry is set to password mode.
10760     *
10761     * @param obj The entry object
10762     * @return If true, the entry is set to display all characters
10763     * as asterisks (*).
10764     *
10765     * @see elm_entry_password_set()
10766     */
10767    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10768    /**
10769     * This sets the text displayed within the entry to @p entry.
10770     *
10771     * @param obj The entry object
10772     * @param entry The text to be displayed
10773     *
10774     * @deprecated Use elm_object_text_set() instead.
10775     * @note Using this function bypasses text filters
10776     */
10777    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10778    /**
10779     * This returns the text currently shown in object @p entry.
10780     * See also elm_entry_entry_set().
10781     *
10782     * @param obj The entry object
10783     * @return The currently displayed text or NULL on failure
10784     *
10785     * @deprecated Use elm_object_text_get() instead.
10786     */
10787    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10788    /**
10789     * Appends @p entry to the text of the entry.
10790     *
10791     * Adds the text in @p entry to the end of any text already present in the
10792     * widget.
10793     *
10794     * The appended text is subject to any filters set for the widget.
10795     *
10796     * @param obj The entry object
10797     * @param entry The text to be displayed
10798     *
10799     * @see elm_entry_text_filter_append()
10800     */
10801    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10802    /**
10803     * Gets whether the entry is empty.
10804     *
10805     * Empty means no text at all. If there are any markup tags, like an item
10806     * tag for which no provider finds anything, and no text is displayed, this
10807     * function still returns EINA_FALSE.
10808     *
10809     * @param obj The entry object
10810     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10811     */
10812    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10813    /**
10814     * Gets any selected text within the entry.
10815     *
10816     * If there's any selected text in the entry, this function returns it as
10817     * a string in markup format. NULL is returned if no selection exists or
10818     * if an error occurred.
10819     *
10820     * The returned value points to an internal string and should not be freed
10821     * or modified in any way. If the @p entry object is deleted or its
10822     * contents are changed, the returned pointer should be considered invalid.
10823     *
10824     * @param obj The entry object
10825     * @return The selected text within the entry or NULL on failure
10826     */
10827    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10828    /**
10829     * Inserts the given text into the entry at the current cursor position.
10830     *
10831     * This inserts text at the cursor position as if it was typed
10832     * by the user (note that this also allows markup which a user
10833     * can't just "type" as it would be converted to escaped text, so this
10834     * call can be used to insert things like emoticon items or bold push/pop
10835     * tags, other font and color change tags etc.)
10836     *
10837     * If any selection exists, it will be replaced by the inserted text.
10838     *
10839     * The inserted text is subject to any filters set for the widget.
10840     *
10841     * @param obj The entry object
10842     * @param entry The text to insert
10843     *
10844     * @see elm_entry_text_filter_append()
10845     */
10846    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10847    /**
10848     * Set the line wrap type to use on multi-line entries.
10849     *
10850     * Sets the wrap type used by the entry to any of the specified in
10851     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10852     * line (without inserting a line break or paragraph separator) when it
10853     * reaches the far edge of the widget.
10854     *
10855     * Note that this only makes sense for multi-line entries. A widget set
10856     * to be single line will never wrap.
10857     *
10858     * @param obj The entry object
10859     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10860     */
10861    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10862    EINA_DEPRECATED EAPI void         elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
10863    /**
10864     * Gets the wrap mode the entry was set to use.
10865     *
10866     * @param obj The entry object
10867     * @return Wrap type
10868     *
10869     * @see also elm_entry_line_wrap_set()
10870     */
10871    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10872    /**
10873     * Sets if the entry is to be editable or not.
10874     *
10875     * By default, entries are editable and when focused, any text input by the
10876     * user will be inserted at the current cursor position. But calling this
10877     * function with @p editable as EINA_FALSE will prevent the user from
10878     * inputting text into the entry.
10879     *
10880     * The only way to change the text of a non-editable entry is to use
10881     * elm_object_text_set(), elm_entry_entry_insert() and other related
10882     * functions.
10883     *
10884     * @param obj The entry object
10885     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10886     * if not, the entry is read-only and no user input is allowed.
10887     */
10888    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10889    /**
10890     * Gets whether the entry is editable or not.
10891     *
10892     * @param obj The entry object
10893     * @return If true, the entry is editable by the user.
10894     * If false, it is not editable by the user
10895     *
10896     * @see elm_entry_editable_set()
10897     */
10898    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10899    /**
10900     * This drops any existing text selection within the entry.
10901     *
10902     * @param obj The entry object
10903     */
10904    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10905    /**
10906     * This selects all text within the entry.
10907     *
10908     * @param obj The entry object
10909     */
10910    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10911    /**
10912     * This moves the cursor one place to the right within the entry.
10913     *
10914     * @param obj The entry object
10915     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10916     */
10917    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10918    /**
10919     * This moves the cursor one place to the left within the entry.
10920     *
10921     * @param obj The entry object
10922     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10923     */
10924    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10925    /**
10926     * This moves the cursor one line up within the entry.
10927     *
10928     * @param obj The entry object
10929     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10930     */
10931    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10932    /**
10933     * This moves the cursor one line down within the entry.
10934     *
10935     * @param obj The entry object
10936     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10937     */
10938    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10939    /**
10940     * This moves the cursor to the beginning of the entry.
10941     *
10942     * @param obj The entry object
10943     */
10944    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10945    /**
10946     * This moves the cursor to the end of the entry.
10947     *
10948     * @param obj The entry object
10949     */
10950    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10951    /**
10952     * This moves the cursor to the beginning of the current line.
10953     *
10954     * @param obj The entry object
10955     */
10956    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10957    /**
10958     * This moves the cursor to the end of the current line.
10959     *
10960     * @param obj The entry object
10961     */
10962    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10963    /**
10964     * This begins a selection within the entry as though
10965     * the user were holding down the mouse button to make a selection.
10966     *
10967     * @param obj The entry object
10968     */
10969    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10970    /**
10971     * This ends a selection within the entry as though
10972     * the user had just released the mouse button while making a selection.
10973     *
10974     * @param obj The entry object
10975     */
10976    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10977    /**
10978     * Gets whether a format node exists at the current cursor position.
10979     *
10980     * A format node is anything that defines how the text is rendered. It can
10981     * be a visible format node, such as a line break or a paragraph separator,
10982     * or an invisible one, such as bold begin or end tag.
10983     * This function returns whether any format node exists at the current
10984     * cursor position.
10985     *
10986     * @param obj The entry object
10987     * @return EINA_TRUE if the current cursor position contains a format node,
10988     * EINA_FALSE otherwise.
10989     *
10990     * @see elm_entry_cursor_is_visible_format_get()
10991     */
10992    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10993    /**
10994     * Gets if the current cursor position holds a visible format node.
10995     *
10996     * @param obj The entry object
10997     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10998     * if it's an invisible one or no format exists.
10999     *
11000     * @see elm_entry_cursor_is_format_get()
11001     */
11002    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11003    /**
11004     * Gets the character pointed by the cursor at its current position.
11005     *
11006     * This function returns a string with the utf8 character stored at the
11007     * current cursor position.
11008     * Only the text is returned, any format that may exist will not be part
11009     * of the return value.
11010     *
11011     * @param obj The entry object
11012     * @return The text pointed by the cursors.
11013     */
11014    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11015    /**
11016     * This function returns the geometry of the cursor.
11017     *
11018     * It's useful if you want to draw something on the cursor (or where it is),
11019     * or for example in the case of scrolled entry where you want to show the
11020     * cursor.
11021     *
11022     * @param obj The entry object
11023     * @param x returned geometry
11024     * @param y returned geometry
11025     * @param w returned geometry
11026     * @param h returned geometry
11027     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11028     */
11029    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);
11030    /**
11031     * Sets the cursor position in the entry to the given value
11032     *
11033     * The value in @p pos is the index of the character position within the
11034     * contents of the string as returned by elm_entry_cursor_pos_get().
11035     *
11036     * @param obj The entry object
11037     * @param pos The position of the cursor
11038     */
11039    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11040    /**
11041     * Retrieves the current position of the cursor in the entry
11042     *
11043     * @param obj The entry object
11044     * @return The cursor position
11045     */
11046    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11047    /**
11048     * This executes a "cut" action on the selected text in the entry.
11049     *
11050     * @param obj The entry object
11051     */
11052    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11053    /**
11054     * This executes a "copy" action on the selected text in the entry.
11055     *
11056     * @param obj The entry object
11057     */
11058    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11059    /**
11060     * This executes a "paste" action in the entry.
11061     *
11062     * @param obj The entry object
11063     */
11064    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11065    /**
11066     * This clears and frees the items in a entry's contextual (longpress)
11067     * menu.
11068     *
11069     * @param obj The entry object
11070     *
11071     * @see elm_entry_context_menu_item_add()
11072     */
11073    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11074    /**
11075     * This adds an item to the entry's contextual menu.
11076     *
11077     * A longpress on an entry will make the contextual menu show up, if this
11078     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11079     * By default, this menu provides a few options like enabling selection mode,
11080     * which is useful on embedded devices that need to be explicit about it,
11081     * and when a selection exists it also shows the copy and cut actions.
11082     *
11083     * With this function, developers can add other options to this menu to
11084     * perform any action they deem necessary.
11085     *
11086     * @param obj The entry object
11087     * @param label The item's text label
11088     * @param icon_file The item's icon file
11089     * @param icon_type The item's icon type
11090     * @param func The callback to execute when the item is clicked
11091     * @param data The data to associate with the item for related functions
11092     */
11093    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);
11094    /**
11095     * This disables the entry's contextual (longpress) menu.
11096     *
11097     * @param obj The entry object
11098     * @param disabled If true, the menu is disabled
11099     */
11100    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11101    /**
11102     * This returns whether the entry's contextual (longpress) menu is
11103     * disabled.
11104     *
11105     * @param obj The entry object
11106     * @return If true, the menu is disabled
11107     */
11108    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11109    /**
11110     * This appends a custom item provider to the list for that entry
11111     *
11112     * This appends the given callback. The list is walked from beginning to end
11113     * with each function called given the item href string in the text. If the
11114     * function returns an object handle other than NULL (it should create an
11115     * object to do this), then this object is used to replace that item. If
11116     * not the next provider is called until one provides an item object, or the
11117     * default provider in entry does.
11118     *
11119     * @param obj The entry object
11120     * @param func The function called to provide the item object
11121     * @param data The data passed to @p func
11122     *
11123     * @see @ref entry-items
11124     */
11125    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);
11126    /**
11127     * This prepends a custom item provider to the list for that entry
11128     *
11129     * This prepends the given callback. See elm_entry_item_provider_append() for
11130     * more information
11131     *
11132     * @param obj The entry object
11133     * @param func The function called to provide the item object
11134     * @param data The data passed to @p func
11135     */
11136    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);
11137    /**
11138     * This removes a custom item provider to the list for that entry
11139     *
11140     * This removes the given callback. See elm_entry_item_provider_append() for
11141     * more information
11142     *
11143     * @param obj The entry object
11144     * @param func The function called to provide the item object
11145     * @param data The data passed to @p func
11146     */
11147    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);
11148    /**
11149     * Append a filter function for text inserted in the entry
11150     *
11151     * Append the given callback to the list. This functions will be called
11152     * whenever any text is inserted into the entry, with the text to be inserted
11153     * as a parameter. The callback function is free to alter the text in any way
11154     * it wants, but it must remember to free the given pointer and update it.
11155     * If the new text is to be discarded, the function can free it and set its
11156     * text parameter to NULL. This will also prevent any following filters from
11157     * being called.
11158     *
11159     * @param obj The entry object
11160     * @param func The function to use as text filter
11161     * @param data User data to pass to @p func
11162     */
11163    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11164    /**
11165     * Prepend a filter function for text insdrted in the entry
11166     *
11167     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11168     * for more information
11169     *
11170     * @param obj The entry object
11171     * @param func The function to use as text filter
11172     * @param data User data to pass to @p func
11173     */
11174    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11175    /**
11176     * Remove a filter from the list
11177     *
11178     * Removes the given callback from the filter list. See
11179     * elm_entry_text_filter_append() for more information.
11180     *
11181     * @param obj The entry object
11182     * @param func The filter function to remove
11183     * @param data The user data passed when adding the function
11184     */
11185    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11186    /**
11187     * This converts a markup (HTML-like) string into UTF-8.
11188     *
11189     * The returned string is a malloc'ed buffer and it should be freed when
11190     * not needed anymore.
11191     *
11192     * @param s The string (in markup) to be converted
11193     * @return The converted string (in UTF-8). It should be freed.
11194     */
11195    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11196    /**
11197     * This converts a UTF-8 string into markup (HTML-like).
11198     *
11199     * The returned string is a malloc'ed buffer and it should be freed when
11200     * not needed anymore.
11201     *
11202     * @param s The string (in UTF-8) to be converted
11203     * @return The converted string (in markup). It should be freed.
11204     */
11205    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11206    /**
11207     * This sets the file (and implicitly loads it) for the text to display and
11208     * then edit. All changes are written back to the file after a short delay if
11209     * the entry object is set to autosave (which is the default).
11210     *
11211     * If the entry had any other file set previously, any changes made to it
11212     * will be saved if the autosave feature is enabled, otherwise, the file
11213     * will be silently discarded and any non-saved changes will be lost.
11214     *
11215     * @param obj The entry object
11216     * @param file The path to the file to load and save
11217     * @param format The file format
11218     */
11219    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11220    /**
11221     * Gets the file being edited by the entry.
11222     *
11223     * This function can be used to retrieve any file set on the entry for
11224     * edition, along with the format used to load and save it.
11225     *
11226     * @param obj The entry object
11227     * @param file The path to the file to load and save
11228     * @param format The file format
11229     */
11230    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11231    /**
11232     * This function writes any changes made to the file set with
11233     * elm_entry_file_set()
11234     *
11235     * @param obj The entry object
11236     */
11237    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11238    /**
11239     * This sets the entry object to 'autosave' the loaded text file or not.
11240     *
11241     * @param obj The entry object
11242     * @param autosave Autosave the loaded file or not
11243     *
11244     * @see elm_entry_file_set()
11245     */
11246    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11247    /**
11248     * This gets the entry object's 'autosave' status.
11249     *
11250     * @param obj The entry object
11251     * @return Autosave the loaded file or not
11252     *
11253     * @see elm_entry_file_set()
11254     */
11255    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11256    /**
11257     * Control pasting of text and images for the widget.
11258     *
11259     * Normally the entry allows both text and images to be pasted.  By setting
11260     * textonly to be true, this prevents images from being pasted.
11261     *
11262     * Note this only changes the behaviour of text.
11263     *
11264     * @param obj The entry object
11265     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11266     * text+image+other.
11267     */
11268    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11269    /**
11270     * Getting elm_entry text paste/drop mode.
11271     *
11272     * In textonly mode, only text may be pasted or dropped into the widget.
11273     *
11274     * @param obj The entry object
11275     * @return If the widget only accepts text from pastes.
11276     */
11277    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11278    /**
11279     * Enable or disable scrolling in entry
11280     *
11281     * Normally the entry is not scrollable unless you enable it with this call.
11282     *
11283     * @param obj The entry object
11284     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11285     */
11286    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11287    /**
11288     * Get the scrollable state of the entry
11289     *
11290     * Normally the entry is not scrollable. This gets the scrollable state
11291     * of the entry. See elm_entry_scrollable_set() for more information.
11292     *
11293     * @param obj The entry object
11294     * @return The scrollable state
11295     */
11296    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11297    /**
11298     * This sets a widget to be displayed to the left of a scrolled entry.
11299     *
11300     * @param obj The scrolled entry object
11301     * @param icon The widget to display on the left side of the scrolled
11302     * entry.
11303     *
11304     * @note A previously set widget will be destroyed.
11305     * @note If the object being set does not have minimum size hints set,
11306     * it won't get properly displayed.
11307     *
11308     * @see elm_entry_end_set()
11309     */
11310    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11311    /**
11312     * Gets the leftmost widget of the scrolled entry. This object is
11313     * owned by the scrolled entry and should not be modified.
11314     *
11315     * @param obj The scrolled entry object
11316     * @return the left widget inside the scroller
11317     */
11318    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11319    /**
11320     * Unset the leftmost widget of the scrolled entry, unparenting and
11321     * returning it.
11322     *
11323     * @param obj The scrolled entry object
11324     * @return the previously set icon sub-object of this entry, on
11325     * success.
11326     *
11327     * @see elm_entry_icon_set()
11328     */
11329    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11330    /**
11331     * Sets the visibility of the left-side widget of the scrolled entry,
11332     * set by elm_entry_icon_set().
11333     *
11334     * @param obj The scrolled entry object
11335     * @param setting EINA_TRUE if the object should be displayed,
11336     * EINA_FALSE if not.
11337     */
11338    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11339    /**
11340     * This sets a widget to be displayed to the end of a scrolled entry.
11341     *
11342     * @param obj The scrolled entry object
11343     * @param end The widget to display on the right side of the scrolled
11344     * entry.
11345     *
11346     * @note A previously set widget will be destroyed.
11347     * @note If the object being set does not have minimum size hints set,
11348     * it won't get properly displayed.
11349     *
11350     * @see elm_entry_icon_set
11351     */
11352    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11353    /**
11354     * Gets the endmost widget of the scrolled entry. This object is owned
11355     * by the scrolled entry and should not be modified.
11356     *
11357     * @param obj The scrolled entry object
11358     * @return the right widget inside the scroller
11359     */
11360    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11361    /**
11362     * Unset the endmost widget of the scrolled entry, unparenting and
11363     * returning it.
11364     *
11365     * @param obj The scrolled entry object
11366     * @return the previously set icon sub-object of this entry, on
11367     * success.
11368     *
11369     * @see elm_entry_icon_set()
11370     */
11371    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11372    /**
11373     * Sets the visibility of the end widget of the scrolled entry, set by
11374     * elm_entry_end_set().
11375     *
11376     * @param obj The scrolled entry object
11377     * @param setting EINA_TRUE if the object should be displayed,
11378     * EINA_FALSE if not.
11379     */
11380    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11381    /**
11382     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11383     * them).
11384     *
11385     * Setting an entry to single-line mode with elm_entry_single_line_set()
11386     * will automatically disable the display of scrollbars when the entry
11387     * moves inside its scroller.
11388     *
11389     * @param obj The scrolled entry object
11390     * @param h The horizontal scrollbar policy to apply
11391     * @param v The vertical scrollbar policy to apply
11392     */
11393    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11394    /**
11395     * This enables/disables bouncing within the entry.
11396     *
11397     * This function sets whether the entry will bounce when scrolling reaches
11398     * the end of the contained entry.
11399     *
11400     * @param obj The scrolled entry object
11401     * @param h The horizontal bounce state
11402     * @param v The vertical bounce state
11403     */
11404    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11405    /**
11406     * Get the bounce mode
11407     *
11408     * @param obj The Entry object
11409     * @param h_bounce Allow bounce horizontally
11410     * @param v_bounce Allow bounce vertically
11411     */
11412    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11413
11414    /* pre-made filters for entries */
11415    /**
11416     * @typedef Elm_Entry_Filter_Limit_Size
11417     *
11418     * Data for the elm_entry_filter_limit_size() entry filter.
11419     */
11420    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11421    /**
11422     * @struct _Elm_Entry_Filter_Limit_Size
11423     *
11424     * Data for the elm_entry_filter_limit_size() entry filter.
11425     */
11426    struct _Elm_Entry_Filter_Limit_Size
11427      {
11428         int max_char_count; /**< The maximum number of characters allowed. */
11429         int max_byte_count; /**< The maximum number of bytes allowed*/
11430      };
11431    /**
11432     * Filter inserted text based on user defined character and byte limits
11433     *
11434     * Add this filter to an entry to limit the characters that it will accept
11435     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11436     * The funtion works on the UTF-8 representation of the string, converting
11437     * it from the set markup, thus not accounting for any format in it.
11438     *
11439     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11440     * it as data when setting the filter. In it, it's possible to set limits
11441     * by character count or bytes (any of them is disabled if 0), and both can
11442     * be set at the same time. In that case, it first checks for characters,
11443     * then bytes.
11444     *
11445     * The function will cut the inserted text in order to allow only the first
11446     * number of characters that are still allowed. The cut is made in
11447     * characters, even when limiting by bytes, in order to always contain
11448     * valid ones and avoid half unicode characters making it in.
11449     *
11450     * This filter, like any others, does not apply when setting the entry text
11451     * directly with elm_object_text_set() (or the deprecated
11452     * elm_entry_entry_set()).
11453     */
11454    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11455    /**
11456     * @typedef Elm_Entry_Filter_Accept_Set
11457     *
11458     * Data for the elm_entry_filter_accept_set() entry filter.
11459     */
11460    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11461    /**
11462     * @struct _Elm_Entry_Filter_Accept_Set
11463     *
11464     * Data for the elm_entry_filter_accept_set() entry filter.
11465     */
11466    struct _Elm_Entry_Filter_Accept_Set
11467      {
11468         const char *accepted; /**< Set of characters accepted in the entry. */
11469         const char *rejected; /**< Set of characters rejected from the entry. */
11470      };
11471    /**
11472     * Filter inserted text based on accepted or rejected sets of characters
11473     *
11474     * Add this filter to an entry to restrict the set of accepted characters
11475     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11476     * This structure contains both accepted and rejected sets, but they are
11477     * mutually exclusive.
11478     *
11479     * The @c accepted set takes preference, so if it is set, the filter will
11480     * only work based on the accepted characters, ignoring anything in the
11481     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11482     *
11483     * In both cases, the function filters by matching utf8 characters to the
11484     * raw markup text, so it can be used to remove formatting tags.
11485     *
11486     * This filter, like any others, does not apply when setting the entry text
11487     * directly with elm_object_text_set() (or the deprecated
11488     * elm_entry_entry_set()).
11489     */
11490    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11491    /**
11492     * Set the input panel layout of the entry
11493     *
11494     * @param obj The entry object
11495     * @param layout layout type
11496     */
11497    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11498    /**
11499     * Get the input panel layout of the entry
11500     *
11501     * @param obj The entry object
11502     * @return layout type
11503     *
11504     * @see elm_entry_input_panel_layout_set
11505     */
11506    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11507    /**
11508     * Set the autocapitalization type on the immodule.
11509     *
11510     * @param obj The entry object
11511     * @param autocapital_type The type of autocapitalization
11512     */
11513    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11514    /**
11515     * Retrieve the autocapitalization type on the immodule.
11516     *
11517     * @param obj The entry object
11518     * @return autocapitalization type
11519     */
11520    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11521    /**
11522     * Sets the attribute to show the input panel automatically.
11523     *
11524     * @param obj The entry object
11525     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11526     */
11527    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11528    /**
11529     * Retrieve the attribute to show the input panel automatically.
11530     *
11531     * @param obj The entry object
11532     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11533     */
11534    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11535
11536    EAPI void         elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11537    EAPI void         elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11538    EAPI void         elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11539    EAPI void         elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11540    EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11541    EAPI void         elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11542    EAPI void         elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11543
11544    EINA_DEPRECATED EAPI void         elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11545    EINA_DEPRECATED EAPI Evas_Coord   elm_entry_wrap_width_get(const Evas_Object *obj);
11546    EINA_DEPRECATED EAPI void         elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11547    EINA_DEPRECATED EAPI void         elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11548    EINA_DEPRECATED EAPI void         elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11549
11550    /**
11551     * @}
11552     */
11553
11554    /* anchorview */
11555    /**
11556     * @defgroup Anchorview Anchorview
11557     *
11558     * Anchorview is for displaying text that contains markup with anchors
11559     * like <c>\<a href=1234\>something\</\></c> in it.
11560     *
11561     * Besides being styled differently, the anchorview widget provides the
11562     * necessary functionality so that clicking on these anchors brings up a
11563     * popup with user defined content such as "call", "add to contacts" or
11564     * "open web page". This popup is provided using the @ref Hover widget.
11565     *
11566     * This widget is very similar to @ref Anchorblock, so refer to that
11567     * widget for an example. The only difference Anchorview has is that the
11568     * widget is already provided with scrolling functionality, so if the
11569     * text set to it is too large to fit in the given space, it will scroll,
11570     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11571     * text can be displayed.
11572     *
11573     * This widget emits the following signals:
11574     * @li "anchor,clicked": will be called when an anchor is clicked. The
11575     * @p event_info parameter on the callback will be a pointer of type
11576     * ::Elm_Entry_Anchorview_Info.
11577     *
11578     * See @ref Anchorblock for an example on how to use both of them.
11579     *
11580     * @see Anchorblock
11581     * @see Entry
11582     * @see Hover
11583     *
11584     * @{
11585     */
11586    /**
11587     * @typedef Elm_Entry_Anchorview_Info
11588     *
11589     * The info sent in the callback for "anchor,clicked" signals emitted by
11590     * the Anchorview widget.
11591     */
11592    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11593    /**
11594     * @struct _Elm_Entry_Anchorview_Info
11595     *
11596     * The info sent in the callback for "anchor,clicked" signals emitted by
11597     * the Anchorview widget.
11598     */
11599    struct _Elm_Entry_Anchorview_Info
11600      {
11601         const char     *name; /**< Name of the anchor, as indicated in its href
11602                                    attribute */
11603         int             button; /**< The mouse button used to click on it */
11604         Evas_Object    *hover; /**< The hover object to use for the popup */
11605         struct {
11606              Evas_Coord    x, y, w, h;
11607         } anchor, /**< Geometry selection of text used as anchor */
11608           hover_parent; /**< Geometry of the object used as parent by the
11609                              hover */
11610         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11611                                              for content on the left side of
11612                                              the hover. Before calling the
11613                                              callback, the widget will make the
11614                                              necessary calculations to check
11615                                              which sides are fit to be set with
11616                                              content, based on the position the
11617                                              hover is activated and its distance
11618                                              to the edges of its parent object
11619                                              */
11620         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11621                                               the right side of the hover.
11622                                               See @ref hover_left */
11623         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11624                                             of the hover. See @ref hover_left */
11625         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11626                                                below the hover. See @ref
11627                                                hover_left */
11628      };
11629    /**
11630     * Add a new Anchorview object
11631     *
11632     * @param parent The parent object
11633     * @return The new object or NULL if it cannot be created
11634     */
11635    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11636    /**
11637     * Set the text to show in the anchorview
11638     *
11639     * Sets the text of the anchorview to @p text. This text can include markup
11640     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11641     * text that will be specially styled and react to click events, ended with
11642     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11643     * "anchor,clicked" signal that you can attach a callback to with
11644     * evas_object_smart_callback_add(). The name of the anchor given in the
11645     * event info struct will be the one set in the href attribute, in this
11646     * case, anchorname.
11647     *
11648     * Other markup can be used to style the text in different ways, but it's
11649     * up to the style defined in the theme which tags do what.
11650     * @deprecated use elm_object_text_set() instead.
11651     */
11652    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11653    /**
11654     * Get the markup text set for the anchorview
11655     *
11656     * Retrieves the text set on the anchorview, with markup tags included.
11657     *
11658     * @param obj The anchorview object
11659     * @return The markup text set or @c NULL if nothing was set or an error
11660     * occurred
11661     * @deprecated use elm_object_text_set() instead.
11662     */
11663    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11664    /**
11665     * Set the parent of the hover popup
11666     *
11667     * Sets the parent object to use by the hover created by the anchorview
11668     * when an anchor is clicked. See @ref Hover for more details on this.
11669     * If no parent is set, the same anchorview object will be used.
11670     *
11671     * @param obj The anchorview object
11672     * @param parent The object to use as parent for the hover
11673     */
11674    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11675    /**
11676     * Get the parent of the hover popup
11677     *
11678     * Get the object used as parent for the hover created by the anchorview
11679     * widget. See @ref Hover for more details on this.
11680     *
11681     * @param obj The anchorview object
11682     * @return The object used as parent for the hover, NULL if none is set.
11683     */
11684    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11685    /**
11686     * Set the style that the hover should use
11687     *
11688     * When creating the popup hover, anchorview will request that it's
11689     * themed according to @p style.
11690     *
11691     * @param obj The anchorview object
11692     * @param style The style to use for the underlying hover
11693     *
11694     * @see elm_object_style_set()
11695     */
11696    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11697    /**
11698     * Get the style that the hover should use
11699     *
11700     * Get the style the hover created by anchorview will use.
11701     *
11702     * @param obj The anchorview object
11703     * @return The style to use by the hover. NULL means the default is used.
11704     *
11705     * @see elm_object_style_set()
11706     */
11707    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11708    /**
11709     * Ends the hover popup in the anchorview
11710     *
11711     * When an anchor is clicked, the anchorview widget will create a hover
11712     * object to use as a popup with user provided content. This function
11713     * terminates this popup, returning the anchorview to its normal state.
11714     *
11715     * @param obj The anchorview object
11716     */
11717    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11718    /**
11719     * Set bouncing behaviour when the scrolled content reaches an edge
11720     *
11721     * Tell the internal scroller object whether it should bounce or not
11722     * when it reaches the respective edges for each axis.
11723     *
11724     * @param obj The anchorview object
11725     * @param h_bounce Whether to bounce or not in the horizontal axis
11726     * @param v_bounce Whether to bounce or not in the vertical axis
11727     *
11728     * @see elm_scroller_bounce_set()
11729     */
11730    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11731    /**
11732     * Get the set bouncing behaviour of the internal scroller
11733     *
11734     * Get whether the internal scroller should bounce when the edge of each
11735     * axis is reached scrolling.
11736     *
11737     * @param obj The anchorview object
11738     * @param h_bounce Pointer where to store the bounce state of the horizontal
11739     *                 axis
11740     * @param v_bounce Pointer where to store the bounce state of the vertical
11741     *                 axis
11742     *
11743     * @see elm_scroller_bounce_get()
11744     */
11745    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11746    /**
11747     * Appends a custom item provider to the given anchorview
11748     *
11749     * Appends the given function to the list of items providers. This list is
11750     * called, one function at a time, with the given @p data pointer, the
11751     * anchorview object and, in the @p item parameter, the item name as
11752     * referenced in its href string. Following functions in the list will be
11753     * called in order until one of them returns something different to NULL,
11754     * which should be an Evas_Object which will be used in place of the item
11755     * element.
11756     *
11757     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11758     * href=item/name\>\</item\>
11759     *
11760     * @param obj The anchorview object
11761     * @param func The function to add to the list of providers
11762     * @param data User data that will be passed to the callback function
11763     *
11764     * @see elm_entry_item_provider_append()
11765     */
11766    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);
11767    /**
11768     * Prepend a custom item provider to the given anchorview
11769     *
11770     * Like elm_anchorview_item_provider_append(), but it adds the function
11771     * @p func to the beginning of the list, instead of the end.
11772     *
11773     * @param obj The anchorview object
11774     * @param func The function to add to the list of providers
11775     * @param data User data that will be passed to the callback function
11776     */
11777    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);
11778    /**
11779     * Remove a custom item provider from the list of the given anchorview
11780     *
11781     * Removes the function and data pairing that matches @p func and @p data.
11782     * That is, unless the same function and same user data are given, the
11783     * function will not be removed from the list. This allows us to add the
11784     * same callback several times, with different @p data pointers and be
11785     * able to remove them later without conflicts.
11786     *
11787     * @param obj The anchorview object
11788     * @param func The function to remove from the list
11789     * @param data The data matching the function to remove from the list
11790     */
11791    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);
11792    /**
11793     * @}
11794     */
11795
11796    /* anchorblock */
11797    /**
11798     * @defgroup Anchorblock Anchorblock
11799     *
11800     * Anchorblock is for displaying text that contains markup with anchors
11801     * like <c>\<a href=1234\>something\</\></c> in it.
11802     *
11803     * Besides being styled differently, the anchorblock widget provides the
11804     * necessary functionality so that clicking on these anchors brings up a
11805     * popup with user defined content such as "call", "add to contacts" or
11806     * "open web page". This popup is provided using the @ref Hover widget.
11807     *
11808     * This widget emits the following signals:
11809     * @li "anchor,clicked": will be called when an anchor is clicked. The
11810     * @p event_info parameter on the callback will be a pointer of type
11811     * ::Elm_Entry_Anchorblock_Info.
11812     *
11813     * @see Anchorview
11814     * @see Entry
11815     * @see Hover
11816     *
11817     * Since examples are usually better than plain words, we might as well
11818     * try @ref tutorial_anchorblock_example "one".
11819     */
11820    /**
11821     * @page tutorial_anchorblock_example Anchorblock/Anchorview example
11822     * This exampel will show both Anchorblock and @ref Anchorview,
11823     * since both are very similar and it's easier to show them once and side
11824     * by side, so the difference is more clear.
11825     *
11826     * We'll show the relevant snippets of the code here, but the full example
11827     * can be found here... sorry, @ref anchorblock_example_01.c "here".
11828     *
11829     * As for the actual example, it's just a simple window with an anchorblock
11830     * and an anchorview, both containing the same text. After including
11831     * Elementary.h and declaring some functions we'll need, we jump to our
11832     * elm_main (see ELM_MAIN) and create our window.
11833     * @dontinclude anchorblock_example_01.c
11834     * @skip int
11835     * @until const char
11836     * @until ;
11837     *
11838     * With the needed variables declared, we'll create the window and a box to
11839     * hold our widgets, but we don't need to go through that here.
11840     *
11841     * In order to make clear where the anchorblock ends and the anchorview
11842     * begins, they'll be each inside a @ref Frame. After creating the frame,
11843     * the anchorblock follows.
11844     * @skip elm_frame_add
11845     * @until elm_frame_content_set
11846     *
11847     * Nothing out of the ordinary there. What's worth mentioning is the call
11848     * to elm_anchorblock_hover_parent_set(). We are telling our widget that
11849     * when an anchor is clicked, the hover for the popup will cover the entire
11850     * window. This affects the area that will be obscured by the hover and
11851     * where clicking will dismiss it, as well as the calculations it does to
11852     * inform the best locations where to insert the popups content.
11853     * Other than that, the code is pretty standard. We also need to set our
11854     * callback for when an anchor is clicked, since it's our task to populate
11855     * the popup. There's no default for it.
11856     *
11857     * The anchorview is no different, we only change a few things so it looks
11858     * different.
11859     * @until elm_frame_content_set
11860     *
11861     * Then we run, so stuff works and close our main function in the usual way.
11862     * @until ELM_MAIN
11863     *
11864     * Now, a little note. Normally you would use either one of anchorblock or
11865     * anchorview, set your one callback to clicks and do your stuff in there.
11866     * In this example, however, there are a few tricks to make it easier to
11867     * show both widgets in one go (and to save me some typing). So we have
11868     * two callbacks, one per widget, that will call a common function to do
11869     * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
11870     * anchorview too, since both are equal, and passing a callback to use
11871     * for our buttons to end the hover, because each widget has a different
11872     * function for it.
11873     * @until _anchorview_clicked_cb
11874     * @until }
11875     *
11876     * The meat of our popup is in the following function. We check what kind
11877     * of menu we need to show, based on the name set to the anchor in the
11878     * markup text. If there's no type (something went wrong, no valid contact
11879     * in the address list) we are just putting a button that does nothing, but
11880     * it's perfectly reasonable to just end the hover and call it quits.
11881     *
11882     * Our popup will consist of one main button in the middle of our hover,
11883     * and possibly a secondary button and a list of other options. We'll create
11884     * first our main button and check what kind of popup we need afterwards.
11885     * @skip static void
11886     * @skip static void
11887     * @until eina_stringshare_add
11888     * @until }
11889     *
11890     * Each button has two callbacks, one is our hack to close the hover
11891     * properly based on which widget it belongs to, the other a simple
11892     * printf that will show the action with the anchors own data. This is
11893     * not how you would usually do it. Instead, the common case is to have
11894     * one callback for the button that will know which function to call to end
11895     * things, but since we are doing it this way it's worth noting that
11896     * smart callbacks will be called in reverse in respect to the order they
11897     * were added, and since our @c btn_end_cb will close the hover, and thus
11898     * delete our buttons, the other callback wouldn't be called if we had
11899     * added it before.
11900     *
11901     * After our telephone popup, there are a few others that are practically
11902     * the same, so they won't be shown here.
11903     *
11904     * Once we are done with that, it's time to place our actions into our
11905     * hover. Main button goes in the middle without much questioning, and then
11906     * we see if we have a secondary button and a box of extra options.
11907     * Because I said so, secondary button goes on either side and box of
11908     * options either on top or below the main one, but to choose which
11909     * exactly, we use the hints our callback info has, which saves us from
11910     * having to do the math and see which side has more space available, with
11911     * a little special case where we delete our extra stuff if there's nowhere
11912     * to place it.
11913     * @skip url:
11914     * @skip }
11915     * @skip evas_object_smart
11916     * @until evas_object_del(box)
11917     * @until }
11918     * @until }
11919     *
11920     * The example will look like this:
11921     * @image html screenshots/anchorblock_01.png
11922     * @image latex screenshots/anchorblock_01.eps
11923     *
11924     * @example anchorblock_example_01.c
11925     */
11926    /**
11927     * @addtogroup Anchorblock
11928     * @{
11929     */
11930    /**
11931     * @typedef Elm_Entry_Anchorblock_Info
11932     *
11933     * The info sent in the callback for "anchor,clicked" signals emitted by
11934     * the Anchorblock widget.
11935     */
11936    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11937    /**
11938     * @struct _Elm_Entry_Anchorblock_Info
11939     *
11940     * The info sent in the callback for "anchor,clicked" signals emitted by
11941     * the Anchorblock widget.
11942     */
11943    struct _Elm_Entry_Anchorblock_Info
11944      {
11945         const char     *name; /**< Name of the anchor, as indicated in its href
11946                                    attribute */
11947         int             button; /**< The mouse button used to click on it */
11948         Evas_Object    *hover; /**< The hover object to use for the popup */
11949         struct {
11950              Evas_Coord    x, y, w, h;
11951         } anchor, /**< Geometry selection of text used as anchor */
11952           hover_parent; /**< Geometry of the object used as parent by the
11953                              hover */
11954         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11955                                              for content on the left side of
11956                                              the hover. Before calling the
11957                                              callback, the widget will make the
11958                                              necessary calculations to check
11959                                              which sides are fit to be set with
11960                                              content, based on the position the
11961                                              hover is activated and its distance
11962                                              to the edges of its parent object
11963                                              */
11964         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11965                                               the right side of the hover.
11966                                               See @ref hover_left */
11967         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11968                                             of the hover. See @ref hover_left */
11969         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11970                                                below the hover. See @ref
11971                                                hover_left */
11972      };
11973    /**
11974     * Add a new Anchorblock object
11975     *
11976     * @param parent The parent object
11977     * @return The new object or NULL if it cannot be created
11978     */
11979    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11980    /**
11981     * Set the text to show in the anchorblock
11982     *
11983     * Sets the text of the anchorblock to @p text. This text can include markup
11984     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11985     * of text that will be specially styled and react to click events, ended
11986     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11987     * "anchor,clicked" signal that you can attach a callback to with
11988     * evas_object_smart_callback_add(). The name of the anchor given in the
11989     * event info struct will be the one set in the href attribute, in this
11990     * case, anchorname.
11991     *
11992     * Other markup can be used to style the text in different ways, but it's
11993     * up to the style defined in the theme which tags do what.
11994     * @deprecated use elm_object_text_set() instead.
11995     */
11996    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11997    /**
11998     * Get the markup text set for the anchorblock
11999     *
12000     * Retrieves the text set on the anchorblock, with markup tags included.
12001     *
12002     * @param obj The anchorblock object
12003     * @return The markup text set or @c NULL if nothing was set or an error
12004     * occurred
12005     * @deprecated use elm_object_text_set() instead.
12006     */
12007    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12008    /**
12009     * Set the parent of the hover popup
12010     *
12011     * Sets the parent object to use by the hover created by the anchorblock
12012     * when an anchor is clicked. See @ref Hover for more details on this.
12013     *
12014     * @param obj The anchorblock object
12015     * @param parent The object to use as parent for the hover
12016     */
12017    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12018    /**
12019     * Get the parent of the hover popup
12020     *
12021     * Get the object used as parent for the hover created by the anchorblock
12022     * widget. See @ref Hover for more details on this.
12023     * If no parent is set, the same anchorblock object will be used.
12024     *
12025     * @param obj The anchorblock object
12026     * @return The object used as parent for the hover, NULL if none is set.
12027     */
12028    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12029    /**
12030     * Set the style that the hover should use
12031     *
12032     * When creating the popup hover, anchorblock will request that it's
12033     * themed according to @p style.
12034     *
12035     * @param obj The anchorblock object
12036     * @param style The style to use for the underlying hover
12037     *
12038     * @see elm_object_style_set()
12039     */
12040    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12041    /**
12042     * Get the style that the hover should use
12043     *
12044     * Get the style the hover created by anchorblock will use.
12045     *
12046     * @param obj The anchorblock object
12047     * @return The style to use by the hover. NULL means the default is used.
12048     *
12049     * @see elm_object_style_set()
12050     */
12051    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12052    /**
12053     * Ends the hover popup in the anchorblock
12054     *
12055     * When an anchor is clicked, the anchorblock widget will create a hover
12056     * object to use as a popup with user provided content. This function
12057     * terminates this popup, returning the anchorblock to its normal state.
12058     *
12059     * @param obj The anchorblock object
12060     */
12061    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12062    /**
12063     * Appends a custom item provider to the given anchorblock
12064     *
12065     * Appends the given function to the list of items providers. This list is
12066     * called, one function at a time, with the given @p data pointer, the
12067     * anchorblock object and, in the @p item parameter, the item name as
12068     * referenced in its href string. Following functions in the list will be
12069     * called in order until one of them returns something different to NULL,
12070     * which should be an Evas_Object which will be used in place of the item
12071     * element.
12072     *
12073     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12074     * href=item/name\>\</item\>
12075     *
12076     * @param obj The anchorblock object
12077     * @param func The function to add to the list of providers
12078     * @param data User data that will be passed to the callback function
12079     *
12080     * @see elm_entry_item_provider_append()
12081     */
12082    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);
12083    /**
12084     * Prepend a custom item provider to the given anchorblock
12085     *
12086     * Like elm_anchorblock_item_provider_append(), but it adds the function
12087     * @p func to the beginning of the list, instead of the end.
12088     *
12089     * @param obj The anchorblock object
12090     * @param func The function to add to the list of providers
12091     * @param data User data that will be passed to the callback function
12092     */
12093    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);
12094    /**
12095     * Remove a custom item provider from the list of the given anchorblock
12096     *
12097     * Removes the function and data pairing that matches @p func and @p data.
12098     * That is, unless the same function and same user data are given, the
12099     * function will not be removed from the list. This allows us to add the
12100     * same callback several times, with different @p data pointers and be
12101     * able to remove them later without conflicts.
12102     *
12103     * @param obj The anchorblock object
12104     * @param func The function to remove from the list
12105     * @param data The data matching the function to remove from the list
12106     */
12107    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);
12108    /**
12109     * @}
12110     */
12111
12112    /**
12113     * @defgroup Bubble Bubble
12114     *
12115     * @image html img/widget/bubble/preview-00.png
12116     * @image latex img/widget/bubble/preview-00.eps
12117     * @image html img/widget/bubble/preview-01.png
12118     * @image latex img/widget/bubble/preview-01.eps
12119     * @image html img/widget/bubble/preview-02.png
12120     * @image latex img/widget/bubble/preview-02.eps
12121     *
12122     * @brief The Bubble is a widget to show text similar to how speech is
12123     * represented in comics.
12124     *
12125     * The bubble widget contains 5 important visual elements:
12126     * @li The frame is a rectangle with rounded edjes and an "arrow".
12127     * @li The @p icon is an image to which the frame's arrow points to.
12128     * @li The @p label is a text which appears to the right of the icon if the
12129     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12130     * otherwise.
12131     * @li The @p info is a text which appears to the right of the label. Info's
12132     * font is of a ligther color than label.
12133     * @li The @p content is an evas object that is shown inside the frame.
12134     *
12135     * The position of the arrow, icon, label and info depends on which corner is
12136     * selected. The four available corners are:
12137     * @li "top_left" - Default
12138     * @li "top_right"
12139     * @li "bottom_left"
12140     * @li "bottom_right"
12141     *
12142     * Signals that you can add callbacks for are:
12143     * @li "clicked" - This is called when a user has clicked the bubble.
12144     *
12145     * For an example of using a buble see @ref bubble_01_example_page "this".
12146     *
12147     * @{
12148     */
12149    /**
12150     * Add a new bubble to the parent
12151     *
12152     * @param parent The parent object
12153     * @return The new object or NULL if it cannot be created
12154     *
12155     * This function adds a text bubble to the given parent evas object.
12156     */
12157    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12158    /**
12159     * Set the label of the bubble
12160     *
12161     * @param obj The bubble object
12162     * @param label The string to set in the label
12163     *
12164     * This function sets the title of the bubble. Where this appears depends on
12165     * the selected corner.
12166     * @deprecated use elm_object_text_set() instead.
12167     */
12168    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12169    /**
12170     * Get the label of the bubble
12171     *
12172     * @param obj The bubble object
12173     * @return The string of set in the label
12174     *
12175     * This function gets the title of the bubble.
12176     * @deprecated use elm_object_text_get() instead.
12177     */
12178    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12179    /**
12180     * Set the info of the bubble
12181     *
12182     * @param obj The bubble object
12183     * @param info The given info about the bubble
12184     *
12185     * This function sets the info of the bubble. Where this appears depends on
12186     * the selected corner.
12187     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12188     */
12189    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12190    /**
12191     * Get the info of the bubble
12192     *
12193     * @param obj The bubble object
12194     *
12195     * @return The "info" string of the bubble
12196     *
12197     * This function gets the info text.
12198     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12199     */
12200    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12201    /**
12202     * Set the content to be shown in the bubble
12203     *
12204     * Once the content object is set, a previously set one will be deleted.
12205     * If you want to keep the old content object, use the
12206     * elm_bubble_content_unset() function.
12207     *
12208     * @param obj The bubble object
12209     * @param content The given content of the bubble
12210     *
12211     * This function sets the content shown on the middle of the bubble.
12212     */
12213    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12214    /**
12215     * Get the content shown in the bubble
12216     *
12217     * Return the content object which is set for this widget.
12218     *
12219     * @param obj The bubble object
12220     * @return The content that is being used
12221     */
12222    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12223    /**
12224     * Unset the content shown in the bubble
12225     *
12226     * Unparent and return the content object which was set for this widget.
12227     *
12228     * @param obj The bubble object
12229     * @return The content that was being used
12230     */
12231    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12232    /**
12233     * Set the icon of the bubble
12234     *
12235     * Once the icon object is set, a previously set one will be deleted.
12236     * If you want to keep the old content object, use the
12237     * elm_icon_content_unset() function.
12238     *
12239     * @param obj The bubble object
12240     * @param icon The given icon for the bubble
12241     */
12242    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12243    /**
12244     * Get the icon of the bubble
12245     *
12246     * @param obj The bubble object
12247     * @return The icon for the bubble
12248     *
12249     * This function gets the icon shown on the top left of bubble.
12250     */
12251    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12252    /**
12253     * Unset the icon of the bubble
12254     *
12255     * Unparent and return the icon object which was set for this widget.
12256     *
12257     * @param obj The bubble object
12258     * @return The icon that was being used
12259     */
12260    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12261    /**
12262     * Set the corner of the bubble
12263     *
12264     * @param obj The bubble object.
12265     * @param corner The given corner for the bubble.
12266     *
12267     * This function sets the corner of the bubble. The corner will be used to
12268     * determine where the arrow in the frame points to and where label, icon and
12269     * info are shown.
12270     *
12271     * Possible values for corner are:
12272     * @li "top_left" - Default
12273     * @li "top_right"
12274     * @li "bottom_left"
12275     * @li "bottom_right"
12276     */
12277    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12278    /**
12279     * Get the corner of the bubble
12280     *
12281     * @param obj The bubble object.
12282     * @return The given corner for the bubble.
12283     *
12284     * This function gets the selected corner of the bubble.
12285     */
12286    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12287
12288    EINA_DEPRECATED EAPI void         elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12289    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12290
12291    /**
12292     * @}
12293     */
12294
12295    /**
12296     * @defgroup Photo Photo
12297     *
12298     * For displaying the photo of a person (contact). Simple, yet
12299     * with a very specific purpose.
12300     *
12301     * Signals that you can add callbacks for are:
12302     *
12303     * "clicked" - This is called when a user has clicked the photo
12304     * "drag,start" - Someone started dragging the image out of the object
12305     * "drag,end" - Dragged item was dropped (somewhere)
12306     *
12307     * @{
12308     */
12309
12310    /**
12311     * Add a new photo to the parent
12312     *
12313     * @param parent The parent object
12314     * @return The new object or NULL if it cannot be created
12315     *
12316     * @ingroup Photo
12317     */
12318    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12319
12320    /**
12321     * Set the file that will be used as photo
12322     *
12323     * @param obj The photo object
12324     * @param file The path to file that will be used as photo
12325     *
12326     * @return (1 = success, 0 = error)
12327     *
12328     * @ingroup Photo
12329     */
12330    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12331
12332    /**
12333     * Set the size that will be used on the photo
12334     *
12335     * @param obj The photo object
12336     * @param size The size that the photo will be
12337     *
12338     * @ingroup Photo
12339     */
12340    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12341
12342    /**
12343     * Set if the photo should be completely visible or not.
12344     *
12345     * @param obj The photo object
12346     * @param fill if true the photo will be completely visible
12347     *
12348     * @ingroup Photo
12349     */
12350    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12351
12352    /**
12353     * Set editability of the photo.
12354     *
12355     * An editable photo can be dragged to or from, and can be cut or
12356     * pasted too.  Note that pasting an image or dropping an item on
12357     * the image will delete the existing content.
12358     *
12359     * @param obj The photo object.
12360     * @param set To set of clear editablity.
12361     */
12362    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12363
12364    /**
12365     * @}
12366     */
12367
12368    /* gesture layer */
12369    /** @defgroup Elm_Gesture_Layer Gesture Layer */
12370    /**
12371     * @enum _Elm_Gesture_Types
12372     * Emum of supported gesture types.
12373     * @ingroup Elm_Gesture_Layer
12374     */
12375    enum _Elm_Gesture_Types
12376      {
12377         ELM_GESTURE_FIRST = 0,
12378
12379         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12380         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12381         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12382         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12383
12384         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12385
12386         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12387         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12388
12389         ELM_GESTURE_ZOOM, /**< Zoom */
12390         ELM_GESTURE_ROTATE, /**< Rotate */
12391
12392         ELM_GESTURE_LAST
12393      };
12394
12395    /**
12396     * @typedef Elm_Gesture_Types
12397     * Type for Emum of supported gesture types.
12398     * @ingroup Elm_Gesture_Layer
12399     */
12400    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12401
12402    /**
12403     * @enum _Elm_Gesture_State
12404     * Emum of gesture states.
12405     * @ingroup Elm_Gesture_Layer
12406     */
12407    enum _Elm_Gesture_State
12408      {
12409         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12410         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12411         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12412         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12413         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12414      };
12415    /**
12416     * @typedef Elm_Gesture_State
12417     * gesture states.
12418     * @ingroup Elm_Gesture_Layer
12419     */
12420    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12421
12422    /**
12423     * @struct _Elm_Gesture_Taps_Info
12424     * Struct holds taps info for user
12425     * @ingroup Elm_Gesture_Layer
12426     */
12427    struct _Elm_Gesture_Taps_Info
12428      {
12429         Evas_Coord x, y;         /**< Holds center point between fingers */
12430         unsigned int n;          /**< Number of fingers tapped           */
12431         unsigned int timestamp;  /**< event timestamp       */
12432      };
12433
12434    /**
12435     * @typedef Elm_Gesture_Taps_Info
12436     * holds taps info for user
12437     * @ingroup Elm_Gesture_Layer
12438     */
12439    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12440
12441    /**
12442     * @struct _Elm_Gesture_Momentum_Info
12443     * Struct holds momentum info for user
12444     * x1 and y1 are not necessarily in sync
12445     * x1 holds x value of x direction starting point
12446     * and same holds for y1.
12447     * This is noticeable when doing V-shape movement
12448     * @ingroup Elm_Gesture_Layer
12449     */
12450    struct _Elm_Gesture_Momentum_Info
12451      {  /* Report line ends, timestamps, and momentum computed        */
12452         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12453         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12454         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12455         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12456
12457         unsigned int tx; /**< Timestamp of start of final x-swipe */
12458         unsigned int ty; /**< Timestamp of start of final y-swipe */
12459
12460         Evas_Coord mx; /**< Momentum on X */
12461         Evas_Coord my; /**< Momentum on Y */
12462
12463         unsigned int n;  /**< Number of fingers */
12464      };
12465
12466    /**
12467     * @typedef Elm_Gesture_Momentum_Info
12468     * holds momentum info for user
12469     * @ingroup Elm_Gesture_Layer
12470     */
12471     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12472
12473    /**
12474     * @struct _Elm_Gesture_Line_Info
12475     * Struct holds line info for user
12476     * @ingroup Elm_Gesture_Layer
12477     */
12478    struct _Elm_Gesture_Line_Info
12479      {  /* Report line ends, timestamps, and momentum computed      */
12480         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12481         /* FIXME should be radians, bot degrees */
12482         double angle;              /**< Angle (direction) of lines  */
12483      };
12484
12485    /**
12486     * @typedef _Elm_Gesture_Line_Info
12487     * Holds line info for user
12488     * @ingroup Elm_Gesture_Layer
12489     */
12490     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12491
12492    /**
12493     * @struct _Elm_Gesture_Zoom_Info
12494     * Struct holds zoom info for user
12495     * @ingroup Elm_Gesture_Layer
12496     */
12497    struct _Elm_Gesture_Zoom_Info
12498      {
12499         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12500         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12501         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12502         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12503      };
12504
12505    /**
12506     * @typedef Elm_Gesture_Zoom_Info
12507     * Holds zoom info for user
12508     * @ingroup Elm_Gesture_Layer
12509     */
12510    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12511
12512    /**
12513     * @struct _Elm_Gesture_Rotate_Info
12514     * Struct holds rotation info for user
12515     * @ingroup Elm_Gesture_Layer
12516     */
12517    struct _Elm_Gesture_Rotate_Info
12518      {
12519         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12520         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12521         double base_angle; /**< Holds start-angle */
12522         double angle;      /**< Rotation value: 0.0 means no rotation         */
12523         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12524      };
12525
12526    /**
12527     * @typedef Elm_Gesture_Rotate_Info
12528     * Holds rotation info for user
12529     * @ingroup Elm_Gesture_Layer
12530     */
12531    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12532
12533    /**
12534     * @typedef Elm_Gesture_Event_Cb
12535     * User callback used to stream gesture info from gesture layer
12536     * @param data user data
12537     * @param event_info gesture report info
12538     * Returns a flag field to be applied on the causing event.
12539     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12540     * upon the event, in an irreversible way.
12541     *
12542     * @ingroup Elm_Gesture_Layer
12543     */
12544    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12545
12546    /**
12547     * Use function to set callbacks to be notified about
12548     * change of state of gesture.
12549     * When a user registers a callback with this function
12550     * this means this gesture has to be tested.
12551     *
12552     * When ALL callbacks for a gesture are set to NULL
12553     * it means user isn't interested in gesture-state
12554     * and it will not be tested.
12555     *
12556     * @param obj Pointer to gesture-layer.
12557     * @param idx The gesture you would like to track its state.
12558     * @param cb callback function pointer.
12559     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12560     * @param data user info to be sent to callback (usually, Smart Data)
12561     *
12562     * @ingroup Elm_Gesture_Layer
12563     */
12564    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);
12565
12566    /**
12567     * Call this function to get repeat-events settings.
12568     *
12569     * @param obj Pointer to gesture-layer.
12570     *
12571     * @return repeat events settings.
12572     * @see elm_gesture_layer_hold_events_set()
12573     * @ingroup Elm_Gesture_Layer
12574     */
12575    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12576
12577    /**
12578     * This function called in order to make gesture-layer repeat events.
12579     * Set this of you like to get the raw events only if gestures were not detected.
12580     * Clear this if you like gesture layer to fwd events as testing gestures.
12581     *
12582     * @param obj Pointer to gesture-layer.
12583     * @param r Repeat: TRUE/FALSE
12584     *
12585     * @ingroup Elm_Gesture_Layer
12586     */
12587    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12588
12589    /**
12590     * This function sets step-value for zoom action.
12591     * Set step to any positive value.
12592     * Cancel step setting by setting to 0.0
12593     *
12594     * @param obj Pointer to gesture-layer.
12595     * @param s new zoom step value.
12596     *
12597     * @ingroup Elm_Gesture_Layer
12598     */
12599    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12600
12601    /**
12602     * This function sets step-value for rotate action.
12603     * Set step to any positive value.
12604     * Cancel step setting by setting to 0.0
12605     *
12606     * @param obj Pointer to gesture-layer.
12607     * @param s new roatate step value.
12608     *
12609     * @ingroup Elm_Gesture_Layer
12610     */
12611    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12612
12613    /**
12614     * This function called to attach gesture-layer to an Evas_Object.
12615     * @param obj Pointer to gesture-layer.
12616     * @param t Pointer to underlying object (AKA Target)
12617     *
12618     * @return TRUE, FALSE on success, failure.
12619     *
12620     * @ingroup Elm_Gesture_Layer
12621     */
12622    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12623
12624    /**
12625     * Call this function to construct a new gesture-layer object.
12626     * This does not activate the gesture layer. You have to
12627     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12628     *
12629     * @param parent the parent object.
12630     *
12631     * @return Pointer to new gesture-layer object.
12632     *
12633     * @ingroup Elm_Gesture_Layer
12634     */
12635    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12636
12637    /* thumb */
12638    typedef enum _Elm_Thumb_Animation_Setting
12639      {
12640         ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
12641         ELM_THUMB_ANIMATION_LOOP,      /* Keep playing animation until stop is requested */
12642         ELM_THUMB_ANIMATION_STOP,
12643         ELM_THUMB_ANIMATION_LAST
12644      } Elm_Thumb_Animation_Setting;
12645
12646    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12647    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12648    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12649    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12650    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12651    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12652    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12653    EAPI void                        *elm_thumb_ethumb_client_get(void);
12654    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12655    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12656    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12657    /* available styles:
12658     * default
12659     * noframe
12660     */
12661    /* smart callbacks called:
12662     * "clicked" - This is called when a user has clicked the thumb without dragging around.
12663     * "clicked,double" - This is called when a user has double-clicked the thumb.
12664     * "press" - This is called when a user has pressed down the thumb.
12665     * "generate,start" - The thumbnail generation started.
12666     * "generate,stop" - The generation process stopped.
12667     * "generate,error" - The generation failed.
12668     * "load,error" - The thumbnail image loading failed.
12669     */
12670
12671    /* hoversel */
12672    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12673
12674    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12675    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12676    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12677    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12678    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12679    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12680    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12681    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12682    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12683    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12684    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12685    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12686    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12687    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12688    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12689    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);
12690    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12691    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12692    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12693    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12694    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);
12695    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);
12696    /* smart callbacks called:
12697     * "clicked" - the user clicked the hoversel button and popped up the sel
12698     * "selected" - an item in the hoversel list is selected
12699     * "dismissed" - the hover is dismissed
12700     */
12701
12702    /* toolbar */
12703    typedef enum _Elm_Toolbar_Shrink_Mode
12704      {
12705         ELM_TOOLBAR_SHRINK_NONE,   /**< set toolbar minimun size to fit all the items */
12706         ELM_TOOLBAR_SHRINK_HIDE,   /**< hide excess items */
12707         ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
12708         ELM_TOOLBAR_SHRINK_MENU    /**< inserts a button to pop up a menu with excess items */
12709      } Elm_Toolbar_Shrink_Mode;
12710
12711    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
12712    typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
12713
12714    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12715    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12716    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12717    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12718    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12719    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12720    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12721    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);
12722    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);
12723    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);
12724    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);
12725    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12726    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12727    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12728    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12729    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12730    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
12731    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12732    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12733    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12734    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
12735    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12736    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
12737    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12738    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12739    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12740    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12741    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
12742    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12743    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12744    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12745    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12746    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
12747    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12748    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
12749    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12750    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
12751    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12752    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
12753    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12754    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12755    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12756    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
12757    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12758    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
12759    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12760    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);
12761    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
12762    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
12763    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
12764    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
12765    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
12766    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
12767    EAPI void                    elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
12768    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);
12769    EAPI void                    elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12770    EAPI void                    elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
12771    EAPI const char             *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12772    EAPI void                    elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
12773    EAPI const char             *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12774    EAPI void                    elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12775    EAPI void                    elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
12776    EAPI const char             *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12777    EAPI void                    elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12778    EAPI Eina_Bool               elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12779    /* smart callbacks called:
12780     * "clicked" - when the user clicks on a toolbar item and becomes selected
12781     */
12782    /* available styles:
12783     * default
12784     * transparent (no background or shadow, just show the provided content)
12785     */
12786
12787    /* tooltip */
12788    EAPI double       elm_tooltip_delay_get(void);
12789    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
12790    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
12791    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
12792    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
12793    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);
12794    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12795    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12796    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12797    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
12798    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12799    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12800    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12801    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12802    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12803    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12804
12805    /* cursors */
12806    EAPI int          elm_cursor_engine_only_get(void);
12807    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
12808
12809    /* menu */
12810    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
12811    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12812    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12813    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12814    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12815    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12816    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12817    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12818    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);
12819    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12820    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12821    EAPI void               elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12822    EAPI const char        *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12823    EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12824    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12825    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12826    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12827    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12828    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12829    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12830    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12831    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12832    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12833    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12834    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12835    EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12836    EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12837    EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12838    EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12839    EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12840
12841    /* smart callbacks called:
12842     * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
12843     */
12844
12845    /* list */
12846    typedef enum _Elm_List_Mode
12847      {
12848         ELM_LIST_COMPRESS = 0,
12849         ELM_LIST_SCROLL,
12850         ELM_LIST_LIMIT,
12851         ELM_LIST_EXPAND,
12852         ELM_LIST_LAST
12853      } Elm_List_Mode;
12854    typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
12855    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12856    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);
12857    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);
12858    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);
12859    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);
12860    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);
12861    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12862    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12863    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12864    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12865    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12866    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12867    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12868    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12869    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12870    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12871    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12872    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12873    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12874    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
12875    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12876    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12877    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12878    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12879    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12880    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12881    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12882    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12883    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12884    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
12885    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12886    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
12887    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12888    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12889    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
12890    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12891    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12892    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
12893    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);
12894    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12895    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
12896    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12897    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
12898    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12899    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
12900    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
12901    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12902    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12903    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
12904    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12905    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
12906    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12907    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12908    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12909    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);
12910    /* smart callbacks called:
12911     * "clicked,double" - when the user double-clicked an item
12912     * "selected" - when the user selected an item
12913     * "unselected" - when the user selected an item
12914     * "longpressed" - an item in the hoversel list is long-pressed
12915     * "scroll,edge,top" - the list is scrolled until the top edge
12916     * "scroll,edge,bottom" - the list is scrolled until the bottom edge
12917     * "scroll,edge,left" - the list is scrolled until the left edge
12918     * "scroll,edge,right" - the list is scrolled until the right edge
12919     */
12920
12921    /* slider */
12922    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12923    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12924    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12925    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12926    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12927    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12928    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
12929    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12930    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12931    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
12932    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12933    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
12934    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12935    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
12936    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12937   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);
12938   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);
12939    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12940    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12941    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
12942    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
12943    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
12944    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12945    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
12946    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12947    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
12948    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12949    /* smart callbacks called:
12950     * "changed" - Whenever the slider value is changed by the user.
12951     * "slider,drag,start" - dragging the slider indicator around has started
12952     * "slider,drag,stop" - dragging the slider indicator around has stopped
12953     * "delay,changed" - A short time after the value is changed by the user.
12954     *                   This will be called only when the user stops dragging for a very short
12955     *                   period or when they release their finger/mouse, so it avoids possibly
12956     *                   expensive reactions to the value change.
12957     */
12958
12959
12960    /* actionslider */
12961
12962    /**
12963     * @addtogroup Actionslider Actionslider
12964     *
12965     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
12966     * properties. The indicator is the element the user drags to choose a label.
12967     * When the position is set with magnet, when released the indicator will be
12968     * moved to it if it's nearest the magnetized position.
12969     *
12970     * @note By default all positions are set as enabled.
12971     *
12972     * Signals that you can add callbacks for are:
12973     *
12974     * "selected" - when user selects an enabled position (the label is passed
12975     *              as event info)".
12976     * @n
12977     * "pos_changed" - when the indicator reaches any of the positions("left",
12978     *                 "right" or "center").
12979     *
12980     * See an example of actionslider usage @ref actionslider_example_page "here"
12981     * @{
12982     */
12983
12984    typedef enum _Elm_Actionslider_Indicator_Pos
12985      {
12986         ELM_ACTIONSLIDER_INDICATOR_NONE,
12987         ELM_ACTIONSLIDER_INDICATOR_LEFT,
12988         ELM_ACTIONSLIDER_INDICATOR_RIGHT,
12989         ELM_ACTIONSLIDER_INDICATOR_CENTER
12990      } Elm_Actionslider_Indicator_Pos;
12991
12992    typedef enum _Elm_Actionslider_Magnet_Pos
12993      {
12994         ELM_ACTIONSLIDER_MAGNET_NONE = 0,
12995         ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
12996         ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
12997         ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
12998         ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
12999         ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
13000      } Elm_Actionslider_Magnet_Pos;
13001
13002    typedef enum _Elm_Actionslider_Label_Pos
13003      {
13004         ELM_ACTIONSLIDER_LABEL_LEFT,
13005         ELM_ACTIONSLIDER_LABEL_RIGHT,
13006         ELM_ACTIONSLIDER_LABEL_CENTER,
13007         ELM_ACTIONSLIDER_LABEL_BUTTON
13008      } Elm_Actionslider_Label_Pos;
13009
13010    /* smart callbacks called:
13011     * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
13012     */
13013
13014    /**
13015     * Add a new actionslider to the parent.
13016     *
13017     * @param parent The parent object
13018     * @return The new actionslider object or NULL if it cannot be created
13019     */
13020    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13021
13022    /**
13023    * Set actionslider label.
13024    *
13025    * @param[in] obj The actionslider object
13026    * @param[in] pos The position of the label.
13027    * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
13028    * @param label The label which is going to be set.
13029    */
13030    EAPI void               elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
13031    /**
13032     * Get actionslider labels.
13033     *
13034     * @param obj The actionslider object
13035     * @param left_label A char** to place the left_label of @p obj into.
13036     * @param center_label A char** to place the center_label of @p obj into.
13037     * @param right_label A char** to place the right_label of @p obj into.
13038     */
13039    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);
13040    /**
13041     * Get actionslider selected label.
13042     *
13043     * @param obj The actionslider object
13044     * @return The selected label
13045     */
13046    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13047    /**
13048     * Set actionslider indicator position.
13049     *
13050     * @param obj The actionslider object.
13051     * @param pos The position of the indicator.
13052     */
13053    EAPI void                elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
13054    /**
13055     * Get actionslider indicator position.
13056     *
13057     * @param obj The actionslider object.
13058     * @return The position of the indicator.
13059     */
13060    EAPI Elm_Actionslider_Indicator_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13061    /**
13062     * Set actionslider magnet position. To make multiple positions magnets @c or
13063     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
13064     *
13065     * @param obj The actionslider object.
13066     * @param pos Bit mask indicating the magnet positions.
13067     */
13068    EAPI void                elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
13069    /**
13070     * Get actionslider magnet position.
13071     *
13072     * @param obj The actionslider object.
13073     * @return The positions with magnet property.
13074     */
13075    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13076    /**
13077     * Set actionslider enabled position. To set multiple positions as enabled @c or
13078     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
13079     *
13080     * @note All the positions are enabled by default.
13081     *
13082     * @param obj The actionslider object.
13083     * @param pos Bit mask indicating the enabled positions.
13084     */
13085    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
13086    /**
13087     * Get actionslider enabled position.
13088     *
13089     * @param obj The actionslider object.
13090     * @return The enabled positions.
13091     */
13092    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13093    /**
13094     * Set the label used on the indicator.
13095     *
13096     * @param obj The actionslider object
13097     * @param label The label to be set on the indicator.
13098     * @deprecated use elm_object_text_set() instead.
13099     */
13100    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13101    /**
13102     * Get the label used on the indicator object.
13103     *
13104     * @param obj The actionslider object
13105     * @return The indicator label
13106     * @deprecated use elm_object_text_get() instead.
13107     */
13108    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13109
13110    /**
13111    * Hold actionslider object movement.
13112    *
13113    * @param[in] obj The actionslider object
13114    * @param[in] flag Actionslider hold/release
13115    * (EINA_TURE = hold/EIN_FALSE = release)
13116    *
13117    * @ingroup Actionslider
13118    */
13119    EAPI void                             elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
13120
13121
13122    /**
13123     *
13124     */
13125
13126    /* genlist */
13127    typedef enum _Elm_Genlist_Item_Flags
13128      {
13129         ELM_GENLIST_ITEM_NONE = 0,
13130         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
13131         ELM_GENLIST_ITEM_GROUP = (1 << 1)
13132      } Elm_Genlist_Item_Flags;
13133    typedef enum _Elm_Genlist_Item_Field_Flags
13134      {
13135         ELM_GENLIST_ITEM_FIELD_ALL = 0,
13136         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
13137         ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
13138         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
13139      } Elm_Genlist_Item_Field_Flags;
13140    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
13141    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
13142    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
13143    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
13144    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
13145    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
13146    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
13147    typedef void         (*GenlistItemMovedFunc)    ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
13148
13149    struct _Elm_Genlist_Item_Class
13150      {
13151         const char                *item_style;
13152         struct {
13153           GenlistItemLabelGetFunc  label_get;
13154           GenlistItemIconGetFunc   icon_get;
13155           GenlistItemStateGetFunc  state_get;
13156           GenlistItemDelFunc       del;
13157           GenlistItemMovedFunc     moved;
13158         } func;
13159         const char *edit_item_style;
13160         const char                *mode_item_style;
13161      };
13162    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13163    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13164    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
13165    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13166    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
13167    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13168    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
13169    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13170    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13171    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13172    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
13173    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13174    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
13175    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13176    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
13177    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
13178    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13179    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13180    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
13181    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13182    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
13183    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13184    /* operations to add items */
13185    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);
13186    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);
13187    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);
13188    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);
13189    /* operations to retrieve existing items */
13190    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13191    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13192    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13193    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);
13194    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13195    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13196    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
13197    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);
13198    /* available item styles:
13199     * default
13200     * default_style - The text part is a textblock
13201     * double_label
13202     * icon_top_text_bottom
13203     */
13204    /* Genlist Item operation */
13205    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13206    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13207    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13208    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
13209    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13210    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13211    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13212    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
13213    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13214    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
13215    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13216    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13217    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
13218    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
13219    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13220    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13221    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13222    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13223    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
13224    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
13225    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13226    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13227    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
13228    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
13229    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
13230    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13231    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
13232    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
13233    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
13234    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
13235    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);
13236    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13237    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
13238    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13239    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13240    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13241    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13242    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
13243    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13244    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13245    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13246    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
13247    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
13248    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13249    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13250    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
13251    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13252    /* Signals that you can add callbacks for are:
13253     * "clicked,double" - This is called when a user has double-clicked an item.
13254     *                    The event_info parameter is the genlist item that was
13255     *                    double-clicked.
13256     * "selected" - This is called when a user has made an item selected. The
13257     *              event_info parameter is the genlist item that was selected.
13258     * "unselected" - This is called when a user has made an item unselected. The
13259     *                 event_info parameter is the genlist item that was unselected.
13260     * "expanded" - This is called when elm_genlist_item_expanded_set() is called
13261     *              and the item is now meant to be expanded. The event_info parameter is the
13262     *              genlist item that was indicated to expand. It is the job of this callback
13263     *              to then fill in the child items.
13264     * "contracted" - This is called when elm_genlist_item_expanded_set() is called
13265     *                and the item is now meant to be contracted. The event_info parameter is
13266     *                the genlist item that was indicated to contract. It is the job of this
13267     *                callback to then delete the child items.
13268     * "expand,request" - This is called when a user has indicated they want to
13269     *                    expand a tree branch item. The callback should decide if the item can
13270     *                    expand (has any children) and then call elm_genlist_item_expanded_set()
13271     *                    appropriately to set the state. The event_info parameter is the genlist
13272     *                    item that was indicated to expand.
13273     * "contract,request" - This is called when a user has indicated they want to
13274     *                      contract a tree branch item. The callback should decide if the item can
13275     *                      contract (has any children) and then call elm_genlist_item_expanded_set()
13276     *                      appropriately to set the state. The event_info parameter is the genlist
13277     *                      item that was indicated to contract.
13278     * "realized" - This is called when the item in the list is created as a real
13279     *              evas object. event_info parameter is the genlist item that was created.
13280     *              The object may be deleted at any time, so it is up to the caller to
13281     *              not use the object pointer from elm_genlist_item_object_get() in a way
13282     *              where it may point to freed objects.
13283     * "unrealized" - This is called just before an item is unrealized. After
13284     *                this call icon objects provided will be deleted and the item object
13285     *                itself delete or be put into a floating cache.
13286     * "drag,start,up" - This is called when the item in the list has been dragged
13287     *                   (not scrolled) up.
13288     * "drag,start,down" - This is called when the item in the list has been dragged
13289     *                     (not scrolled) down.
13290     * "drag,start,left" - This is called when the item in the list has been dragged i
13291     *                     (not scrolled) left.
13292     * "drag,start,right" - This is called when the item in the list has been dragged
13293     *                      (not scrolled) right.
13294     * "drag,stop" - This is called when the item in the list has stopped being
13295     *               dragged.
13296     * "drag" - This is called when the item in the list is being dragged.
13297     * "longpressed" - This is called when the item is pressed for a certain amount
13298     *                 of time. By default it's 1 second.
13299     * "scroll,anim,start" - This is called when scrolling animation has started.
13300     * "scroll,anim,stop" - This is called when scrolling animation has stopped.
13301     * "scroll,drag,start" - This is called when dragging the content has started.
13302     * "scroll,drag,stop" - This is called when dragging the content has stopped.
13303     * "scroll,edge,top" - This is called when the genlist is scrolled until the
13304     *                     top edge.
13305     * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
13306     *                         bottom edge.
13307     * "scroll,edge,left" - This is called when the genlist is scrolled until the
13308     *                      left edge.
13309     * "scroll,edge,right" - This is called when the genlist is scrolled until the
13310     *                       right edge.
13311     * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
13312     *                       left.
13313     * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
13314     *                       right.
13315     * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
13316     * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
13317     *                      down.
13318     * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
13319     *                     out.
13320     * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
13321     */
13322
13323    EAPI void               elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
13324    EAPI Eina_Bool          elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13325    EAPI void               elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
13326    EAPI Eina_Bool          elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
13327    EAPI void               elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
13328    EAPI void               elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
13329    EAPI void               elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
13330    EAPI void               elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
13331    EAPI void               elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
13332    EAPI Eina_Bool          elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13333
13334    /**
13335     * @page tutorial_check Check example
13336     * @dontinclude check_example_01.c
13337     *
13338     * This example will show 2 checkboxes, one with just a label and the second
13339     * one with both a label and an icon. This example also ilustrates how to
13340     * have the checkbox change the value of a variable and how to react to those
13341     * changes.
13342     *
13343     * We will start with the usual setup code:
13344     * @until show(bg)
13345     *
13346     * And now we create our first checkbox, set its label, tell it to change
13347     * the value of @p value when the checkbox stats is changed and ask to be
13348     * notified of state changes:
13349     * @until show
13350     *
13351     * For our second checkbox we are going to set an icon so we need to create
13352     * and icon:
13353     * @until show
13354     * @note For simplicity we are using a rectangle as icon, but any evas object
13355     * can be used.
13356     *
13357     * And for our second checkbox we set the label, icon and state to true:
13358     * @until show
13359     *
13360     * We now do some more setup:
13361     * @until ELM_MAIN
13362     *
13363     * And finally implement the callback that will be called when the first
13364     * checkbox's state changes. This callback will use @p data to print a
13365     * message:
13366     * @until }
13367     * @note This work because @p data is @p value(from the main function) and @p
13368     * value is changed when the checkbox is changed.
13369     *
13370     * Our example will look like this:
13371     * @image html screenshots/check_example_01.png
13372     * @image latex screenshots/check_example_01.eps
13373     *
13374     * @example check_example_01.c
13375     */
13376    /**
13377     * @defgroup Check Check
13378     *
13379     * @brief The check widget allows for toggling a value between true and
13380     * false.
13381     *
13382     * Check objects are a lot like radio objects in layout and functionality
13383     * except they do not work as a group, but independently and only toggle the
13384     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
13385     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
13386     * returns the current state. For convenience, like the radio objects, you
13387     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
13388     * for it to modify.
13389     *
13390     * Signals that you can add callbacks for are:
13391     * "changed" - This is called whenever the user changes the state of one of
13392     *             the check object(event_info is NULL).
13393     *
13394     * @ref tutorial_check should give you a firm grasp of how to use this widget.
13395     * @{
13396     */
13397    /**
13398     * @brief Add a new Check object
13399     *
13400     * @param parent The parent object
13401     * @return The new object or NULL if it cannot be created
13402     */
13403    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13404    /**
13405     * @brief Set the text label of the check object
13406     *
13407     * @param obj The check object
13408     * @param label The text label string in UTF-8
13409     *
13410     * @deprecated use elm_object_text_set() instead.
13411     */
13412    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13413    /**
13414     * @brief Get the text label of the check object
13415     *
13416     * @param obj The check object
13417     * @return The text label string in UTF-8
13418     *
13419     * @deprecated use elm_object_text_get() instead.
13420     */
13421    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13422    /**
13423     * @brief Set the icon object of the check object
13424     *
13425     * @param obj The check object
13426     * @param icon The icon object
13427     *
13428     * Once the icon object is set, a previously set one will be deleted.
13429     * If you want to keep that old content object, use the
13430     * elm_check_icon_unset() function.
13431     */
13432    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13433    /**
13434     * @brief Get the icon object of the check object
13435     *
13436     * @param obj The check object
13437     * @return The icon object
13438     */
13439    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13440    /**
13441     * @brief Unset the icon used for the check object
13442     *
13443     * @param obj The check object
13444     * @return The icon object that was being used
13445     *
13446     * Unparent and return the icon object which was set for this widget.
13447     */
13448    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13449    /**
13450     * @brief Set the on/off state of the check object
13451     *
13452     * @param obj The check object
13453     * @param state The state to use (1 == on, 0 == off)
13454     *
13455     * This sets the state of the check. If set
13456     * with elm_check_state_pointer_set() the state of that variable is also
13457     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
13458     */
13459    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
13460    /**
13461     * @brief Get the state of the check object
13462     *
13463     * @param obj The check object
13464     * @return The boolean state
13465     */
13466    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13467    /**
13468     * @brief Set a convenience pointer to a boolean to change
13469     *
13470     * @param obj The check object
13471     * @param statep Pointer to the boolean to modify
13472     *
13473     * This sets a pointer to a boolean, that, in addition to the check objects
13474     * state will also be modified directly. To stop setting the object pointed
13475     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
13476     * then when this is called, the check objects state will also be modified to
13477     * reflect the value of the boolean @p statep points to, just like calling
13478     * elm_check_state_set().
13479     */
13480    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
13481    /**
13482     * @}
13483     */
13484
13485    /* radio */
13486    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13487    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13488    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13489    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13490    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13491    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13492    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
13493    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
13494    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13495    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
13496    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13497    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
13498    /* smart callbacks called:
13499     * "changed" - when the radio status is changed
13500     */
13501
13502    /* pager */
13503    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13504    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13505    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
13506    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13507    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13508    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13509    EAPI void         elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
13510    EAPI void         elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
13511
13512    /* available item styles:
13513     * default
13514     * fade
13515     * fade_translucide
13516     * fade_invisible
13517     */
13518    /* smart callbacks called:
13519     * "hide,finished" - when the previous page is hided
13520     */
13521
13522    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
13523    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
13524    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
13525    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
13526    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
13527
13528    struct _Elm_Slideshow_Item_Class
13529      {
13530         struct _Elm_Slideshow_Item_Class_Func
13531           {
13532              SlideshowItemGetFunc get;
13533              SlideshowItemDelFunc del;
13534           } func;
13535      };
13536
13537    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13538    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
13539    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);
13540    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
13541    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
13542    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
13543    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13544    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
13545    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13546    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
13547    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13548    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
13549    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13550    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13551    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13552    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
13553    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
13554    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13555    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
13556    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
13557    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13558    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
13559    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13560    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
13561    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13562    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
13563    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13564    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13565    /* smart callbacks called:
13566     * "changed" - when the slideshow switch to another item
13567     */
13568
13569    /* file selector */
13570    typedef enum _Elm_Fileselector_Mode
13571      {
13572         ELM_FILESELECTOR_LIST = 0,
13573         ELM_FILESELECTOR_GRID,
13574         ELM_FILESELECTOR_LAST
13575      } Elm_Fileselector_Mode;
13576
13577    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13578    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
13579    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13580    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
13581    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13582    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
13583    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13584    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13585    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
13586    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
13587    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13588    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13589    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
13590    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
13591    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13592    /* smart callbacks called:
13593     * "selected" - the user click on a file
13594     * "directory,open" - the list is populate with a new content. event_info is a directory.
13595     * "done" - the user click on the ok or cancel buttons
13596     */
13597
13598    /* progressbar */
13599    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13600    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
13601    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13602    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
13603    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13604    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13605    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13606    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13607    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13608    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13609    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13610    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13611    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13612    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13613    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13614    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13615    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13616    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
13617    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13618    /* smart callbacks called:
13619     */
13620    /* available item styles:
13621     * default
13622     * wheel (simple style, no text, no progression, only pulse is available)
13623     */
13624
13625    /* separator */
13626    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13627    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13628    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13629    /* smart callbacks called:
13630     */
13631
13632    /* spinner */
13633    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13634    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
13635    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13636    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
13637    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
13638    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
13639    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13640    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
13641    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13642    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
13643    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13644    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
13645    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13646    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
13647    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
13648    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13649    /* smart callbacks called:
13650     * "changed" - when the spinner value changes
13651     * "delay,changed" - when the spinner value changed, but a small time after a change (use this if you only want to respond to a change once the spinner is held still for a short while).
13652     */
13653    /* available item styles:
13654     * default
13655     * vertical (two up/down buttons at the right side and text left aligned)
13656     */
13657
13658    /* index */
13659    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
13660
13661    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13662    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
13663    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13664    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
13665    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13666    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
13667    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
13668    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
13669    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
13670    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
13671    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);
13672    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
13673    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
13674    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13675    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
13676    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
13677    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
13678    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13679    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
13680    EAPI void            elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
13681    /* smart callbacks called:
13682     * "changed" - when the selected index item changes
13683     * "delay,changed" - when the selected index item changes, but after some small idle period
13684     * "selected" - when the user releases a finger and selects an item
13685     * "level,up" - when the user moves a finger from the first level to the second level
13686     * "level,down" - when the user moves a finger from the second level to the first level
13687     */
13688
13689    /* photocam */
13690    typedef enum _Elm_Photocam_Zoom_Mode
13691      {
13692         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
13693         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
13694         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
13695         ELM_PHOTOCAM_ZOOM_MODE_LAST
13696      } Elm_Photocam_Zoom_Mode;
13697
13698    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13699    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
13700    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13701    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
13702    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13703    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
13704    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13705    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
13706    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
13707    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
13708    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
13709    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
13710    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13711    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13712    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
13713    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
13714    /* smart callbacks called:
13715     * "clicked" - when image clicked
13716     * "press" - when mouse/finger held down initially on image
13717     * "longpressed" - when mouse/finger held for long time on image
13718     * "clicked,double" - when mouse/finger double-clicked
13719     * "load" - when photo load begins
13720     * "loaded" - when photo load done
13721     * "load,detail" - when detailed image load begins
13722     * "loaded,detail" - when detailed image load done
13723     * "zoom,start" - when zooming started
13724     * "zoom,stop" - when zooming stopped
13725     * "zoom,change" - when auto zoom mode changed zoom level
13726     * "scroll - the content has been scrolled (moved)
13727     * "scroll,anim,start" - scrolling animation has started
13728     * "scroll,anim,stop" - scrolling animation has stopped
13729     * "scroll,drag,start" - dragging the contents around has started
13730     * "scroll,drag,stop" - dragging the contents around has stopped
13731     */
13732
13733    /* map */
13734    typedef enum _Elm_Map_Zoom_Mode
13735      {
13736         ELM_MAP_ZOOM_MODE_MANUAL,
13737         ELM_MAP_ZOOM_MODE_AUTO_FIT,
13738         ELM_MAP_ZOOM_MODE_AUTO_FILL,
13739         ELM_MAP_ZOOM_MODE_LAST
13740      } Elm_Map_Zoom_Mode;
13741
13742    typedef enum _Elm_Map_Route_Sources
13743      {
13744         ELM_MAP_ROUTE_SOURCE_YOURS,
13745         ELM_MAP_ROUTE_SOURCE_MONAV,
13746         ELM_MAP_ROUTE_SOURCE_ORS,
13747         ELM_MAP_ROUTE_SOURCE_LAST
13748      } Elm_Map_Route_Sources;
13749
13750    typedef enum _Elm_Map_Name_Sources
13751      {
13752         ELM_MAP_NAME_SOURCE_NOMINATIM,
13753         ELM_MAP_NAME_SOURCE_LAST
13754      } Elm_Map_Name_Sources;
13755
13756    typedef enum _Elm_Map_Route_Type
13757      {
13758         ELM_MAP_ROUTE_TYPE_MOTOCAR,
13759         ELM_MAP_ROUTE_TYPE_BICYCLE,
13760         ELM_MAP_ROUTE_TYPE_FOOT,
13761         ELM_MAP_ROUTE_TYPE_LAST
13762      } Elm_Map_Route_Type;
13763
13764    typedef enum _Elm_Map_Route_Method
13765      {
13766         ELM_MAP_ROUTE_METHOD_FASTEST,
13767         ELM_MAP_ROUTE_METHOD_SHORTEST,
13768         ELM_MAP_ROUTE_METHOD_LAST
13769      } Elm_Map_Route_Method;
13770
13771    typedef enum _Elm_Map_Name_Method
13772      {
13773         ELM_MAP_NAME_METHOD_SEARCH,
13774         ELM_MAP_NAME_METHOD_REVERSE,
13775         ELM_MAP_NAME_METHOD_LAST
13776      } Elm_Map_Name_Method;
13777
13778    typedef struct _Elm_Map_Marker          Elm_Map_Marker;
13779    typedef struct _Elm_Map_Marker_Class    Elm_Map_Marker_Class;
13780    typedef struct _Elm_Map_Group_Class     Elm_Map_Group_Class;
13781    typedef struct _Elm_Map_Route           Elm_Map_Route;
13782    typedef struct _Elm_Map_Name            Elm_Map_Name;
13783    typedef struct _Elm_Map_Track           Elm_Map_Track;
13784
13785    typedef Evas_Object *(*ElmMapMarkerGetFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
13786    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
13787    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
13788    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data);
13789
13790    typedef char        *(*ElmMapModuleSourceFunc) (void);
13791    typedef int          (*ElmMapModuleZoomMinFunc) (void);
13792    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
13793    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
13794    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
13795    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
13796    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
13797    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
13798    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
13799
13800    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13801    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
13802    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13803    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
13804    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13805    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
13806    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
13807    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
13808    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
13809    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13810    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
13811    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13812    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
13813    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);
13814    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);
13815    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
13816    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
13817    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);
13818    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);
13819    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
13820    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
13821    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
13822    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
13823    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
13824    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
13825    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
13826    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
13827    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
13828    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
13829    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
13830    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
13831    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
13832    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
13833    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
13834    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
13835    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
13836    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
13837    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
13838    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
13839    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
13840    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13841    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
13842    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13843    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
13844    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13845    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
13846    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13847    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
13848    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13849    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
13850    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13851    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);
13852    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
13853    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
13854    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
13855    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
13856    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
13857    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
13858    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
13859    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
13860    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
13861    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
13862    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);
13863    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13864    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13865 #ifdef ELM_EMAP
13866    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
13867 #endif
13868    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
13869
13870    /* smart callbacks called:
13871     * "clicked" - when image clicked
13872     * "press" - when mouse/finger held down initially on image
13873     * "longpressed" - when mouse/finger held for long time on image
13874     * "clicked,double" - when mouse/finger double-clicked
13875     * "load,details" - when detailed image load begins
13876     * "loaded,details" - when detailed image load done
13877     * "zoom,start" - when zooming started
13878     * "zoom,stop" - when zooming stopped
13879     * "zoom,change" - when auto zoom mode changed zoom level
13880     * "scroll - the content has been scrolled (moved)
13881     * "scroll,anim,start" - scrolling animation has started
13882     * "scroll,anim,stop" - scrolling animation has stopped
13883     * "scroll,drag,start" - dragging the contents around has started
13884     * "scroll,drag,stop" - dragging the contents around has stopped
13885     */
13886
13887    /* Route */
13888    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
13889 #ifdef ELM_EMAP
13890    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
13891 #endif
13892    EAPI double elm_route_lon_min_get(Evas_Object *obj);
13893    EAPI double elm_route_lat_min_get(Evas_Object *obj);
13894    EAPI double elm_route_lon_max_get(Evas_Object *obj);
13895    EAPI double elm_route_lat_max_get(Evas_Object *obj);
13896
13897
13898    /* panel */
13899    typedef enum _Elm_Panel_Orient
13900      {
13901         ELM_PANEL_ORIENT_TOP,
13902         ELM_PANEL_ORIENT_BOTTOM,
13903         ELM_PANEL_ORIENT_LEFT,
13904         ELM_PANEL_ORIENT_RIGHT,
13905      } Elm_Panel_Orient;
13906
13907    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13908    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
13909    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13910    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13911    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13912    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13913    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
13914    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13915    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
13916
13917    /* panes */
13918    /**
13919     * TODO
13920     *
13921     * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
13922     * Add events (move, start ...)
13923     */
13924    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13925    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13926    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13927    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13928    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13929    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13930    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13931    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13932    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
13933    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13934    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13935    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
13936    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13937
13938    /* flip */
13939    typedef enum _Elm_Flip_Mode
13940      {
13941         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
13942         ELM_FLIP_ROTATE_X_CENTER_AXIS,
13943         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
13944         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
13945         ELM_FLIP_CUBE_LEFT,
13946         ELM_FLIP_CUBE_RIGHT,
13947         ELM_FLIP_CUBE_UP,
13948         ELM_FLIP_CUBE_DOWN,
13949         ELM_FLIP_PAGE_LEFT,
13950         ELM_FLIP_PAGE_RIGHT,
13951         ELM_FLIP_PAGE_UP,
13952         ELM_FLIP_PAGE_DOWN
13953      } Elm_Flip_Mode;
13954    typedef enum _Elm_Flip_Interaction
13955      {
13956         ELM_FLIP_INTERACTION_NONE,
13957         ELM_FLIP_INTERACTION_ROTATE,
13958         ELM_FLIP_INTERACTION_CUBE,
13959         ELM_FLIP_INTERACTION_PAGE
13960      } Elm_Flip_Interaction;
13961    typedef enum _Elm_Flip_Direction
13962      {
13963         ELM_FLIP_DIRECTION_UP,
13964         ELM_FLIP_DIRECTION_DOWN,
13965         ELM_FLIP_DIRECTION_LEFT,
13966         ELM_FLIP_DIRECTION_RIGHT
13967      } Elm_Flip_Direction;
13968
13969    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13970    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13971    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13972    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13973    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13974    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13975    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13976    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13977    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
13978    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
13979    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
13980    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
13981    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
13982    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
13983    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
13984    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
13985    /* smart callbacks called:
13986     * "animate,begin" - when a flip animation was started
13987     * "animate,done" - when a flip animation is finished
13988     */
13989
13990    /* scrolledentry */
13991    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13992    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
13993    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13994    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
13995    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13996    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
13997    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13998    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
13999    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14000    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14001    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
14002    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
14003    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
14004    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14005    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
14006    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
14007    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
14008    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
14009    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
14010    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
14011    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
14012    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
14013    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
14014    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
14015    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14016    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14017    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14018    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14019    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14020    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
14021    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14022    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
14023    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
14024    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
14025    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14026    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);
14027    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14028    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14029    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);
14030    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14031    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);
14032    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
14033    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14034    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14035    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
14036    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
14037    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14038    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14039    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
14040    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);
14041    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);
14042    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);
14043    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);
14044    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);
14045    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);
14046    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
14047    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
14048    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
14049    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
14050    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14051    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
14052    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14053    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
14054    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
14055    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
14056    EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
14057    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
14058    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
14059
14060    /* conformant */
14061    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14062    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
14063    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14064    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14065    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14066
14067    /* mapbuf */
14068    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14069    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
14070    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14071    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14072    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
14073    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14074    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
14075    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14076    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
14077    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14078
14079    /**
14080     * @defgroup Flipselector Flip Selector
14081     *
14082     * A flip selector is a widget to show a set of @b text items, one
14083     * at a time, with the same sheet switching style as the @ref Clock
14084     * "clock" widget, when one changes the current displaying sheet
14085     * (thus, the "flip" in the name).
14086     *
14087     * User clicks to flip sheets which are @b held for some time will
14088     * make the flip selector to flip continuosly and automatically for
14089     * the user. The interval between flips will keep growing in time,
14090     * so that it helps the user to reach an item which is distant from
14091     * the current selection.
14092     *
14093     * Smart callbacks one can register to:
14094     * - @c "selected" - when the widget's selected text item is changed
14095     * - @c "overflowed" - when the widget's current selection is changed
14096     *   from the first item in its list to the last
14097     * - @c "underflowed" - when the widget's current selection is changed
14098     *   from the last item in its list to the first
14099     *
14100     * Available styles for it:
14101     * - @c "default"
14102     *
14103     * Here is an example on its usage:
14104     * @li @ref flipselector_example
14105     */
14106
14107    /**
14108     * @addtogroup Flipselector
14109     * @{
14110     */
14111
14112    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
14113
14114    /**
14115     * Add a new flip selector widget to the given parent Elementary
14116     * (container) widget
14117     *
14118     * @param parent The parent object
14119     * @return a new flip selector widget handle or @c NULL, on errors
14120     *
14121     * This function inserts a new flip selector widget on the canvas.
14122     *
14123     * @ingroup Flipselector
14124     */
14125    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14126
14127    /**
14128     * Programmatically select the next item of a flip selector widget
14129     *
14130     * @param obj The flipselector object
14131     *
14132     * @note The selection will be animated. Also, if it reaches the
14133     * end of its list of member items, it will continue with the first
14134     * one onwards.
14135     *
14136     * @ingroup Flipselector
14137     */
14138    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
14139
14140    /**
14141     * Programmatically select the previous item of a flip selector
14142     * widget
14143     *
14144     * @param obj The flipselector object
14145     *
14146     * @note The selection will be animated.  Also, if it reaches the
14147     * beginning of its list of member items, it will continue with the
14148     * last one backwards.
14149     *
14150     * @ingroup Flipselector
14151     */
14152    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
14153
14154    /**
14155     * Append a (text) item to a flip selector widget
14156     *
14157     * @param obj The flipselector object
14158     * @param label The (text) label of the new item
14159     * @param func Convenience callback function to take place when
14160     * item is selected
14161     * @param data Data passed to @p func, above
14162     * @return A handle to the item added or @c NULL, on errors
14163     *
14164     * The widget's list of labels to show will be appended with the
14165     * given value. If the user wishes so, a callback function pointer
14166     * can be passed, which will get called when this same item is
14167     * selected.
14168     *
14169     * @note The current selection @b won't be modified by appending an
14170     * element to the list.
14171     *
14172     * @note The maximum length of the text label is going to be
14173     * determined <b>by the widget's theme</b>. Strings larger than
14174     * that value are going to be @b truncated.
14175     *
14176     * @ingroup Flipselector
14177     */
14178    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
14179
14180    /**
14181     * Prepend a (text) item to a flip selector widget
14182     *
14183     * @param obj The flipselector object
14184     * @param label The (text) label of the new item
14185     * @param func Convenience callback function to take place when
14186     * item is selected
14187     * @param data Data passed to @p func, above
14188     * @return A handle to the item added or @c NULL, on errors
14189     *
14190     * The widget's list of labels to show will be prepended with the
14191     * given value. If the user wishes so, a callback function pointer
14192     * can be passed, which will get called when this same item is
14193     * selected.
14194     *
14195     * @note The current selection @b won't be modified by prepending
14196     * an element to the list.
14197     *
14198     * @note The maximum length of the text label is going to be
14199     * determined <b>by the widget's theme</b>. Strings larger than
14200     * that value are going to be @b truncated.
14201     *
14202     * @ingroup Flipselector
14203     */
14204    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
14205
14206    /**
14207     * Get the internal list of items in a given flip selector widget.
14208     *
14209     * @param obj The flipselector object
14210     * @return The list of items (#Elm_Flipselector_Item as data) or @c
14211     * NULL on errors.
14212     *
14213     * This list is @b not to be modified in any way and must not be
14214     * freed. Use the list members with functions like
14215     * elm_flipselector_item_label_set(),
14216     * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
14217     * elm_flipselector_item_del(),
14218     * elm_flipselector_item_selected_get(),
14219     * elm_flipselector_item_selected_set().
14220     *
14221     * @warning This list is only valid until @p obj object's internal
14222     * items list is changed. It should be fetched again with another
14223     * call to this function when changes happen.
14224     *
14225     * @ingroup Flipselector
14226     */
14227    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14228
14229    /**
14230     * Get the first item in the given flip selector widget's list of
14231     * items.
14232     *
14233     * @param obj The flipselector object
14234     * @return The first item or @c NULL, if it has no items (and on
14235     * errors)
14236     *
14237     * @see elm_flipselector_item_append()
14238     * @see elm_flipselector_last_item_get()
14239     *
14240     * @ingroup Flipselector
14241     */
14242    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14243
14244    /**
14245     * Get the last item in the given flip selector widget's list of
14246     * items.
14247     *
14248     * @param obj The flipselector object
14249     * @return The last item or @c NULL, if it has no items (and on
14250     * errors)
14251     *
14252     * @see elm_flipselector_item_prepend()
14253     * @see elm_flipselector_first_item_get()
14254     *
14255     * @ingroup Flipselector
14256     */
14257    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14258
14259    /**
14260     * Get the currently selected item in a flip selector widget.
14261     *
14262     * @param obj The flipselector object
14263     * @return The selected item or @c NULL, if the widget has no items
14264     * (and on erros)
14265     *
14266     * @ingroup Flipselector
14267     */
14268    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14269
14270    /**
14271     * Set whether a given flip selector widget's item should be the
14272     * currently selected one.
14273     *
14274     * @param item The flip selector item
14275     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
14276     *
14277     * This sets whether @p item is or not the selected (thus, under
14278     * display) one. If @p item is different than one under display,
14279     * the latter will be unselected. If the @p item is set to be
14280     * unselected, on the other hand, the @b first item in the widget's
14281     * internal members list will be the new selected one.
14282     *
14283     * @see elm_flipselector_item_selected_get()
14284     *
14285     * @ingroup Flipselector
14286     */
14287    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14288
14289    /**
14290     * Get whether a given flip selector widget's item is the currently
14291     * selected one.
14292     *
14293     * @param item The flip selector item
14294     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
14295     * (or on errors).
14296     *
14297     * @see elm_flipselector_item_selected_set()
14298     *
14299     * @ingroup Flipselector
14300     */
14301    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
14302
14303    /**
14304     * Delete a given item from a flip selector widget.
14305     *
14306     * @param item The item to delete
14307     *
14308     * @ingroup Flipselector
14309     */
14310    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
14311
14312    /**
14313     * Get the label of a given flip selector widget's item.
14314     *
14315     * @param item The item to get label from
14316     * @return The text label of @p item or @c NULL, on errors
14317     *
14318     * @see elm_flipselector_item_label_set()
14319     *
14320     * @ingroup Flipselector
14321     */
14322    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
14323
14324    /**
14325     * Set the label of a given flip selector widget's item.
14326     *
14327     * @param item The item to set label on
14328     * @param label The text label string, in UTF-8 encoding
14329     *
14330     * @see elm_flipselector_item_label_get()
14331     *
14332     * @ingroup Flipselector
14333     */
14334    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
14335
14336    /**
14337     * Gets the item before @p item in a flip selector widget's
14338     * internal list of items.
14339     *
14340     * @param item The item to fetch previous from
14341     * @return The item before the @p item, in its parent's list. If
14342     *         there is no previous item for @p item or there's an
14343     *         error, @c NULL is returned.
14344     *
14345     * @see elm_flipselector_item_next_get()
14346     *
14347     * @ingroup Flipselector
14348     */
14349    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
14350
14351    /**
14352     * Gets the item after @p item in a flip selector widget's
14353     * internal list of items.
14354     *
14355     * @param item The item to fetch next from
14356     * @return The item after the @p item, in its parent's list. If
14357     *         there is no next item for @p item or there's an
14358     *         error, @c NULL is returned.
14359     *
14360     * @see elm_flipselector_item_next_get()
14361     *
14362     * @ingroup Flipselector
14363     */
14364    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
14365
14366    /**
14367     * Set the interval on time updates for an user mouse button hold
14368     * on a flip selector widget.
14369     *
14370     * @param obj The flip selector object
14371     * @param interval The (first) interval value in seconds
14372     *
14373     * This interval value is @b decreased while the user holds the
14374     * mouse pointer either flipping up or flipping doww a given flip
14375     * selector.
14376     *
14377     * This helps the user to get to a given item distant from the
14378     * current one easier/faster, as it will start to flip quicker and
14379     * quicker on mouse button holds.
14380     *
14381     * The calculation for the next flip interval value, starting from
14382     * the one set with this call, is the previous interval divided by
14383     * 1.05, so it decreases a little bit.
14384     *
14385     * The default starting interval value for automatic flips is
14386     * @b 0.85 seconds.
14387     *
14388     * @see elm_flipselector_interval_get()
14389     *
14390     * @ingroup Flipselector
14391     */
14392    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
14393
14394    /**
14395     * Get the interval on time updates for an user mouse button hold
14396     * on a flip selector widget.
14397     *
14398     * @param obj The flip selector object
14399     * @return The (first) interval value, in seconds, set on it
14400     *
14401     * @see elm_flipselector_interval_set() for more details
14402     *
14403     * @ingroup Flipselector
14404     */
14405    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14406
14407    /**
14408     * @}
14409     */
14410
14411    /**
14412     * @addtogroup Animator Animator
14413     * @ingroup Elementary
14414     *
14415     * @brief Functions to ease creation of animations.
14416     *
14417     * elm_animator is designed to provide an easy way to create animations.
14418     * Creating an animation with elm_animator is as simple as setting a
14419     * duration, an operating callback and telling it to run the animation.
14420     * However that is not the full extent of elm_animator's ability, animations
14421     * can be paused and resumed, reversed and the animation need not be linear.
14422     *
14423     * To run an animation you must specify at least a duration and operation
14424     * callback, not setting any other properties will create a linear animation
14425     * that runs once and is not reversed.
14426     *
14427     * @ref elm_animator_example_page_01 "This" example should make all of that
14428     * very clear.
14429     *
14430     * @warning elm_animator is @b not a widget.
14431     * @{
14432     */
14433    /**
14434     * @brief Type of curve desired for animation.
14435     *
14436     * The speed in which an animation happens doesn't have to be linear, some
14437     * animations will look better if they're accelerating or decelerating, so
14438     * elm_animator provides four options in this regard:
14439     * @image html elm_animator_curve_style.png
14440     * @image latex elm_animator_curve_style.eps width=\textwidth
14441     * As can be seen in the image the speed of the animation will be:
14442     * @li ELM_ANIMATOR_CURVE_LINEAR constant
14443     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
14444     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
14445     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
14446     */
14447    typedef enum
14448      {
14449         ELM_ANIMATOR_CURVE_LINEAR,
14450         ELM_ANIMATOR_CURVE_IN_OUT,
14451         ELM_ANIMATOR_CURVE_IN,
14452         ELM_ANIMATOR_CURVE_OUT
14453      } Elm_Animator_Curve_Style;
14454    typedef struct _Elm_Animator Elm_Animator;
14455   /**
14456    * Called back per loop of an elementary animators cycle
14457    * @param data user-data given to elm_animator_operation_callback_set()
14458    * @param animator the animator being run
14459    * @param double the position in the animation
14460    */
14461    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
14462   /**
14463    * Called back when an elementary animator finishes
14464    * @param data user-data given to elm_animator_completion_callback_set()
14465    */
14466    typedef void (*Elm_Animator_Completion_Cb) (void *data);
14467
14468    /**
14469     * @brief Create a new animator.
14470     *
14471     * @param[in] parent Parent object
14472     *
14473     * The @a parent argument can be set to NULL for no parent. If a parent is set
14474     * there is no need to call elm_animator_del(), when the parent is deleted it
14475     * will delete the animator.
14476     * @deprecated Use @ref Transit instead.
14477
14478     */
14479    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
14480    /**
14481     * Deletes the animator freeing any resources it used. If the animator was
14482     * created with a NULL parent this must be called, otherwise it will be
14483     * automatically called when the parent is deleted.
14484     *
14485     * @param[in] animator Animator object
14486     * @deprecated Use @ref Transit instead.
14487     */
14488    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
14489    /**
14490     * Set the duration of the animation.
14491     *
14492     * @param[in] animator Animator object
14493     * @param[in] duration Duration in second
14494     * @deprecated Use @ref Transit instead.
14495     */
14496    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
14497    /**
14498     * @brief Set the callback function for animator operation.
14499     *
14500     * @param[in] animator Animator object
14501     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
14502     * @param[in] data Callback function user argument
14503     *
14504     * The @p func callback will be called with a frame value in range [0, 1] which
14505     * indicates how far along the animation should be. It is the job of @p func to
14506     * actually change the state of any object(or objects) that are being animated.
14507     * @deprecated Use @ref Transit instead.
14508     */
14509    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
14510    /**
14511     * Set the callback function for the when the animation ends.
14512     *
14513     * @param[in]  animator Animator object
14514     * @param[in]  func   Callback function pointe
14515     * @param[in]  data Callback function user argument
14516     *
14517     * @warning @a func will not be executed if elm_animator_stop() is called.
14518     * @deprecated Use @ref Transit instead.
14519     */
14520    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
14521    /**
14522     * @brief Stop animator.
14523     *
14524     * @param[in] animator Animator object
14525     *
14526     * If called before elm_animator_animate() it does nothing. If there is an
14527     * animation in progress the animation will be stopped(the operation callback
14528     * will not be executed again) and it can't be restarted using
14529     * elm_animator_resume().
14530     * @deprecated Use @ref Transit instead.
14531     */
14532    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
14533    /**
14534     * Set the animator repeat count.
14535     *
14536     * @param[in]  animator Animator object
14537     * @param[in]  repeat_cnt Repeat count
14538     * @deprecated Use @ref Transit instead.
14539     */
14540    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
14541    /**
14542     * @brief Start animation.
14543     *
14544     * @param[in] animator Animator object
14545     *
14546     * This function starts the animation if the nescessary properties(duration
14547     * and operation callback) have been set. Once started the animation will
14548     * run until complete or elm_animator_stop() is called.
14549     * @deprecated Use @ref Transit instead.
14550     */
14551    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
14552    /**
14553     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
14554     *
14555     * @param[in] animator Animator object
14556     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
14557     * @deprecated Use @ref Transit instead.
14558     */
14559    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
14560    /**
14561     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
14562     *
14563     * @param[in] animator Animator object
14564     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
14565     * @deprecated Use @ref Transit instead.
14566     */
14567    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
14568    /**
14569     * @brief Sets wether the animation should be automatically reversed.
14570     *
14571     * @param[in] animator Animator object
14572     * @param[in] reverse Reverse or not
14573     *
14574     * This controls wether the animation will be run on reverse imediately after
14575     * running forward. When this is set together with repetition the animation
14576     * will run in reverse once for each time it ran forward.@n
14577     * Runnin an animation in reverse is accomplished by calling the operation
14578     * callback with a frame value starting at 1 and diminshing until 0.
14579     * @deprecated Use @ref Transit instead.
14580     */
14581    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
14582    /**
14583     * Gets wether the animation will automatically reversed
14584     *
14585     * @param[in] animator Animator object
14586     * @deprecated Use @ref Transit instead.
14587     */
14588    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
14589    /**
14590     * Gets the status for the animator operation. The status of the animator @b
14591     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
14592     * only informs if the animation was started and has not ended(either normally
14593     * or through elm_animator_stop()).
14594     *
14595     * @param[in] animator Animator object
14596     * @deprecated Use @ref Transit instead.
14597     */
14598    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
14599    /**
14600     * Gets how many times the animation will be repeated
14601     *
14602     * @param[in] animator Animator object
14603     * @deprecated Use @ref Transit instead.
14604     */
14605    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
14606    /**
14607     * Pause the animator.
14608     *
14609     * @param[in]  animator Animator object
14610     *
14611     * This causes the animation to be temporarily stopped(the operation callback
14612     * will not be called). If the animation is not yet running this is a no-op.
14613     * Once an animation has been paused with this function it can be resumed
14614     * using elm_animator_resume().
14615     * @deprecated Use @ref Transit instead.
14616     */
14617    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
14618    /**
14619     * @brief Resumes the animator.
14620     *
14621     * @param[in]  animator Animator object
14622     *
14623     * Resumes an animation that was paused using elm_animator_pause(), after
14624     * calling this function calls to the operation callback will happen
14625     * normally. If an animation is stopped by means of elm_animator_stop it
14626     * @b can't be restarted with this function.@n
14627     *
14628     * @warning When an animation is resumed it doesn't start from where it was paused, it
14629     * will go to where it would have been if it had not been paused. If an
14630     * animation with a duration of 3 seconds is paused after 1 second for 1 second
14631     * it will resume as if it had ben animating for 2 seconds, the operating
14632     * callback will be called with a frame value of aproximately 2/3.
14633     * @deprecated Use @ref Transit instead.
14634     */
14635    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
14636    /**
14637     * @}
14638     */
14639
14640    /* calendar */
14641    typedef enum
14642      {
14643         ELM_CALENDAR_UNIQUE,
14644         ELM_CALENDAR_DAILY,
14645         ELM_CALENDAR_WEEKLY,
14646         ELM_CALENDAR_MONTHLY,
14647         ELM_CALENDAR_ANNUALLY
14648      } Elm_Calendar_Mark_Repeat;
14649    typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
14650
14651    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14652    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14653    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
14654    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14655    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
14656    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
14657    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
14658    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14659    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
14660    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
14661    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
14662    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
14663    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);
14664    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
14665    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14666    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14667    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
14668    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
14669    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
14670    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
14671    /* smart callbacks called:
14672     * changed - emitted when the user select a day or change the displayed
14673     * month.
14674     */
14675
14676    /* diskselector */
14677    typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
14678
14679    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14680    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14681    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
14682    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14683    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
14684    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14685    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
14686    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14687    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14688    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);
14689    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14690    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14691    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14692    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);
14693    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14694    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14695    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14696    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14697    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
14698    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14699    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
14700    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14701    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14702    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14703    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14704    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14705    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14706    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14707    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
14708    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);
14709    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14710    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
14711    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14712    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14713    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14714    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14715    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
14716    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14717    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14718    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
14719    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
14720    /* smart callbacks called:
14721     * "selected" - when item is selected (scroller stops)
14722     */
14723
14724    /**
14725     * @page tutorial_colorselector Color selector example
14726     * @dontinclude colorselector_example_01.c
14727     *
14728     * This example shows how to change the color of a rectangle using a color
14729     * selector. We aren't going to explain a lot of the code since it's the
14730     * usual setup code:
14731     * @until show(rect)
14732     *
14733     * Now that we have a window with background and a rectangle we can create
14734     * our color_selector and set it's initial color to fully opaque blue:
14735     * @until show
14736     *
14737     * Next we tell ask to be notified whenever the color changes:
14738     * @until changed
14739     *
14740     * We follow that we some more run of the mill setup code:
14741     * @until ELM_MAIN()
14742     *
14743     * And now get to the callback that sets the color of the rectangle:
14744     * @until }
14745     *
14746     * This example will look like this:
14747     * @image html screenshots/colorselector_example_01.png
14748     * @image latex screenshots/colorselector_example_01.eps
14749     *
14750     * @example colorselector_example_01.c
14751     */
14752    /**
14753     * @defgroup Colorselector Colorselector
14754     *
14755     * @{
14756     *
14757     * @brief Widget for user to select a color.
14758     *
14759     * Signals that you can add callbacks for are:
14760     * "changed" - When the color value changes(event_info is NULL).
14761     *
14762     * See @ref tutorial_colorselector.
14763     */
14764    /**
14765     * @brief Add a new colorselector to the parent
14766     *
14767     * @param parent The parent object
14768     * @return The new object or NULL if it cannot be created
14769     *
14770     * @ingroup Colorselector
14771     */
14772    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14773    /**
14774     * Set a color for the colorselector
14775     *
14776     * @param obj   Colorselector object
14777     * @param r     r-value of color
14778     * @param g     g-value of color
14779     * @param b     b-value of color
14780     * @param a     a-value of color
14781     *
14782     * @ingroup Colorselector
14783     */
14784    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
14785    /**
14786     * Get a color from the colorselector
14787     *
14788     * @param obj   Colorselector object
14789     * @param r     integer pointer for r-value of color
14790     * @param g     integer pointer for g-value of color
14791     * @param b     integer pointer for b-value of color
14792     * @param a     integer pointer for a-value of color
14793     *
14794     * @ingroup Colorselector
14795     */
14796    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
14797    /**
14798     * @}
14799     */
14800
14801    /* Contextual Popup */
14802    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
14803
14804    typedef enum _Elm_Ctxpopup_Direction
14805      {
14806         ELM_CTXPOPUP_DIRECTION_DOWN,
14807         ELM_CTXPOPUP_DIRECTION_RIGHT,
14808         ELM_CTXPOPUP_DIRECTION_LEFT,
14809         ELM_CTXPOPUP_DIRECTION_UP,
14810         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
14811      } Elm_Ctxpopup_Direction;
14812
14813    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14814    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14815    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
14816    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14817    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
14818    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
14819    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14820    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14821    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14822    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14823    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);
14824    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14825    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14826    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
14827    EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
14828    EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14829    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);
14830    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);
14831    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14832    /* smart callbacks called:
14833     * "dismissed" - the ctxpopup was dismissed
14834     */
14835
14836    /* transit */
14837    /**
14838     *
14839     * @defgroup Transit Transit
14840     * @ingroup Elementary
14841     *
14842     * Transit is designed to apply various animated transition effects to @c
14843     * Evas_Object, such like translation, rotation, etc. For using these
14844     * effects, create an @ref Elm_Transit and add the desired transition effects.
14845     *
14846     * Once the effects are added into transit, they will be automatically
14847     * managed (their callback will be called until the duration is ended, and
14848     * they will be deleted on completion).
14849     *
14850     * Example:
14851     * @code
14852     * Elm_Transit *trans = elm_transit_add();
14853     * elm_transit_object_add(trans, obj);
14854     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
14855     * elm_transit_duration_set(transit, 1);
14856     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
14857     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
14858     * elm_transit_repeat_times_set(transit, 3);
14859     * @endcode
14860     *
14861     * Some transition effects are used to change the properties of objects. They
14862     * are:
14863     * @li @ref elm_transit_effect_translation_add
14864     * @li @ref elm_transit_effect_color_add
14865     * @li @ref elm_transit_effect_rotation_add
14866     * @li @ref elm_transit_effect_wipe_add
14867     * @li @ref elm_transit_effect_zoom_add
14868     * @li @ref elm_transit_effect_resizing_add
14869     *
14870     * Other transition effects are used to make one object disappear and another
14871     * object appear on its old place. These effects are:
14872     *
14873     * @li @ref elm_transit_effect_flip_add
14874     * @li @ref elm_transit_effect_resizable_flip_add
14875     * @li @ref elm_transit_effect_fade_add
14876     * @li @ref elm_transit_effect_blend_add
14877     *
14878     * It's also possible to make a transition chain with @ref
14879     * elm_transit_chain_transit_add.
14880     *
14881     * @warning We strongly recommend to use elm_transit just when edje can not do
14882     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
14883     * animations can be manipulated inside the theme.
14884     *
14885     * List of examples:
14886     * @li @ref transit_example_01_explained
14887     * @li @ref transit_example_02_explained
14888     * @li @ref transit_example_03_c
14889     * @li @ref transit_example_04_c
14890     *
14891     * @{
14892     */
14893
14894    /**
14895     * @enum Elm_Transit_Tween_Mode
14896     *
14897     * The type of acceleration used in the transition.
14898     */
14899    typedef enum
14900      {
14901         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
14902         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
14903                                              over time, then decrease again
14904                                              and stop slowly */
14905         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
14906                                              speed over time */
14907         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
14908                                             over time */
14909      } Elm_Transit_Tween_Mode;
14910
14911    /**
14912     * @enum Elm_Transit_Effect_Flip_Axis
14913     *
14914     * The axis where flip effect should be applied.
14915     */
14916    typedef enum
14917      {
14918         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
14919         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
14920      } Elm_Transit_Effect_Flip_Axis;
14921    /**
14922     * @enum Elm_Transit_Effect_Wipe_Dir
14923     *
14924     * The direction where the wipe effect should occur.
14925     */
14926    typedef enum
14927      {
14928         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
14929         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
14930         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
14931         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
14932      } Elm_Transit_Effect_Wipe_Dir;
14933    /** @enum Elm_Transit_Effect_Wipe_Type
14934     *
14935     * Whether the wipe effect should show or hide the object.
14936     */
14937    typedef enum
14938      {
14939         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
14940                                              animation */
14941         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
14942                                             animation */
14943      } Elm_Transit_Effect_Wipe_Type;
14944
14945    /**
14946     * @typedef Elm_Transit
14947     *
14948     * The Transit created with elm_transit_add(). This type has the information
14949     * about the objects which the transition will be applied, and the
14950     * transition effects that will be used. It also contains info about
14951     * duration, number of repetitions, auto-reverse, etc.
14952     */
14953    typedef struct _Elm_Transit Elm_Transit;
14954    typedef void Elm_Transit_Effect;
14955    /**
14956     * @typedef Elm_Transit_Effect_Transition_Cb
14957     *
14958     * Transition callback called for this effect on each transition iteration.
14959     */
14960    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
14961    /**
14962     * Elm_Transit_Effect_End_Cb
14963     *
14964     * Transition callback called for this effect when the transition is over.
14965     */
14966    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
14967
14968    /**
14969     * Elm_Transit_Del_Cb
14970     *
14971     * A callback called when the transit is deleted.
14972     */
14973    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
14974
14975    /**
14976     * Add new transit.
14977     *
14978     * @note Is not necessary to delete the transit object, it will be deleted at
14979     * the end of its operation.
14980     * @note The transit will start playing when the program enter in the main loop, is not
14981     * necessary to give a start to the transit.
14982     *
14983     * @return The transit object.
14984     *
14985     * @ingroup Transit
14986     */
14987    EAPI Elm_Transit                *elm_transit_add(void);
14988
14989    /**
14990     * Stops the animation and delete the @p transit object.
14991     *
14992     * Call this function if you wants to stop the animation before the duration
14993     * time. Make sure the @p transit object is still alive with
14994     * elm_transit_del_cb_set() function.
14995     * All added effects will be deleted, calling its repective data_free_cb
14996     * functions. The function setted by elm_transit_del_cb_set() will be called.
14997     *
14998     * @see elm_transit_del_cb_set()
14999     *
15000     * @param transit The transit object to be deleted.
15001     *
15002     * @ingroup Transit
15003     * @warning Just call this function if you are sure the transit is alive.
15004     */
15005    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
15006
15007    /**
15008     * Add a new effect to the transit.
15009     *
15010     * @note The cb function and the data are the key to the effect. If you try to
15011     * add an already added effect, nothing is done.
15012     * @note After the first addition of an effect in @p transit, if its
15013     * effect list become empty again, the @p transit will be killed by
15014     * elm_transit_del(transit) function.
15015     *
15016     * Exemple:
15017     * @code
15018     * Elm_Transit *transit = elm_transit_add();
15019     * elm_transit_effect_add(transit,
15020     *                        elm_transit_effect_blend_op,
15021     *                        elm_transit_effect_blend_context_new(),
15022     *                        elm_transit_effect_blend_context_free);
15023     * @endcode
15024     *
15025     * @param transit The transit object.
15026     * @param transition_cb The operation function. It is called when the
15027     * animation begins, it is the function that actually performs the animation.
15028     * It is called with the @p data, @p transit and the time progression of the
15029     * animation (a double value between 0.0 and 1.0).
15030     * @param effect The context data of the effect.
15031     * @param end_cb The function to free the context data, it will be called
15032     * at the end of the effect, it must finalize the animation and free the
15033     * @p data.
15034     *
15035     * @ingroup Transit
15036     * @warning The transit free the context data at the and of the transition with
15037     * the data_free_cb function, do not use the context data in another transit.
15038     */
15039    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);
15040
15041    /**
15042     * Delete an added effect.
15043     *
15044     * This function will remove the effect from the @p transit, calling the
15045     * data_free_cb to free the @p data.
15046     *
15047     * @see elm_transit_effect_add()
15048     *
15049     * @note If the effect is not found, nothing is done.
15050     * @note If the effect list become empty, this function will call
15051     * elm_transit_del(transit), that is, it will kill the @p transit.
15052     *
15053     * @param transit The transit object.
15054     * @param transition_cb The operation function.
15055     * @param effect The context data of the effect.
15056     *
15057     * @ingroup Transit
15058     */
15059    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);
15060
15061    /**
15062     * Add new object to apply the effects.
15063     *
15064     * @note After the first addition of an object in @p transit, if its
15065     * object list become empty again, the @p transit will be killed by
15066     * elm_transit_del(transit) function.
15067     * @note If the @p obj belongs to another transit, the @p obj will be
15068     * removed from it and it will only belong to the @p transit. If the old
15069     * transit stays without objects, it will die.
15070     * @note When you add an object into the @p transit, its state from
15071     * evas_object_pass_events_get(obj) is saved, and it is applied when the
15072     * transit ends, if you change this state whith evas_object_pass_events_set()
15073     * after add the object, this state will change again when @p transit stops to
15074     * run.
15075     *
15076     * @param transit The transit object.
15077     * @param obj Object to be animated.
15078     *
15079     * @ingroup Transit
15080     * @warning It is not allowed to add a new object after transit begins to go.
15081     */
15082    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
15083
15084    /**
15085     * Removes an added object from the transit.
15086     *
15087     * @note If the @p obj is not in the @p transit, nothing is done.
15088     * @note If the list become empty, this function will call
15089     * elm_transit_del(transit), that is, it will kill the @p transit.
15090     *
15091     * @param transit The transit object.
15092     * @param obj Object to be removed from @p transit.
15093     *
15094     * @ingroup Transit
15095     * @warning It is not allowed to remove objects after transit begins to go.
15096     */
15097    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
15098
15099    /**
15100     * Get the objects of the transit.
15101     *
15102     * @param transit The transit object.
15103     * @return a Eina_List with the objects from the transit.
15104     *
15105     * @ingroup Transit
15106     */
15107    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15108
15109    /**
15110     * Enable/disable keeping up the objects states.
15111     * If it is not kept, the objects states will be reset when transition ends.
15112     *
15113     * @note @p transit can not be NULL.
15114     * @note One state includes geometry, color, map data.
15115     *
15116     * @param transit The transit object.
15117     * @param state_keep Keeping or Non Keeping.
15118     *
15119     * @ingroup Transit
15120     */
15121    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
15122
15123    /**
15124     * Get a value whether the objects states will be reset or not.
15125     *
15126     * @note @p transit can not be NULL
15127     *
15128     * @see elm_transit_objects_final_state_keep_set()
15129     *
15130     * @param transit The transit object.
15131     * @return EINA_TRUE means the states of the objects will be reset.
15132     * If @p transit is NULL, EINA_FALSE is returned
15133     *
15134     * @ingroup Transit
15135     */
15136    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15137
15138    /**
15139     * Set the event enabled when transit is operating.
15140     *
15141     * If @p enabled is EINA_TRUE, the objects of the transit will receives
15142     * events from mouse and keyboard during the animation.
15143     * @note When you add an object with elm_transit_object_add(), its state from
15144     * evas_object_pass_events_get(obj) is saved, and it is applied when the
15145     * transit ends, if you change this state with evas_object_pass_events_set()
15146     * after adding the object, this state will change again when @p transit stops
15147     * to run.
15148     *
15149     * @param transit The transit object.
15150     * @param enabled Events are received when enabled is @c EINA_TRUE, and
15151     * ignored otherwise.
15152     *
15153     * @ingroup Transit
15154     */
15155    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
15156
15157    /**
15158     * Get the value of event enabled status.
15159     *
15160     * @see elm_transit_event_enabled_set()
15161     *
15162     * @param transit The Transit object
15163     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
15164     * EINA_FALSE is returned
15165     *
15166     * @ingroup Transit
15167     */
15168    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15169
15170    /**
15171     * Set the user-callback function when the transit is deleted.
15172     *
15173     * @note Using this function twice will overwrite the first function setted.
15174     * @note the @p transit object will be deleted after call @p cb function.
15175     *
15176     * @param transit The transit object.
15177     * @param cb Callback function pointer. This function will be called before
15178     * the deletion of the transit.
15179     * @param data Callback funtion user data. It is the @p op parameter.
15180     *
15181     * @ingroup Transit
15182     */
15183    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
15184
15185    /**
15186     * Set reverse effect automatically.
15187     *
15188     * If auto reverse is setted, after running the effects with the progress
15189     * parameter from 0 to 1, it will call the effecs again with the progress
15190     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
15191     * where the duration was setted with the function elm_transit_add and
15192     * the repeat with the function elm_transit_repeat_times_set().
15193     *
15194     * @param transit The transit object.
15195     * @param reverse EINA_TRUE means the auto_reverse is on.
15196     *
15197     * @ingroup Transit
15198     */
15199    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
15200
15201    /**
15202     * Get if the auto reverse is on.
15203     *
15204     * @see elm_transit_auto_reverse_set()
15205     *
15206     * @param transit The transit object.
15207     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
15208     * EINA_FALSE is returned
15209     *
15210     * @ingroup Transit
15211     */
15212    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15213
15214    /**
15215     * Set the transit repeat count. Effect will be repeated by repeat count.
15216     *
15217     * This function sets the number of repetition the transit will run after
15218     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
15219     * If the @p repeat is a negative number, it will repeat infinite times.
15220     *
15221     * @note If this function is called during the transit execution, the transit
15222     * will run @p repeat times, ignoring the times it already performed.
15223     *
15224     * @param transit The transit object
15225     * @param repeat Repeat count
15226     *
15227     * @ingroup Transit
15228     */
15229    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
15230
15231    /**
15232     * Get the transit repeat count.
15233     *
15234     * @see elm_transit_repeat_times_set()
15235     *
15236     * @param transit The Transit object.
15237     * @return The repeat count. If @p transit is NULL
15238     * 0 is returned
15239     *
15240     * @ingroup Transit
15241     */
15242    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15243
15244    /**
15245     * Set the transit animation acceleration type.
15246     *
15247     * This function sets the tween mode of the transit that can be:
15248     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
15249     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
15250     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
15251     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
15252     *
15253     * @param transit The transit object.
15254     * @param tween_mode The tween type.
15255     *
15256     * @ingroup Transit
15257     */
15258    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
15259
15260    /**
15261     * Get the transit animation acceleration type.
15262     *
15263     * @note @p transit can not be NULL
15264     *
15265     * @param transit The transit object.
15266     * @return The tween type. If @p transit is NULL
15267     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
15268     *
15269     * @ingroup Transit
15270     */
15271    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15272
15273    /**
15274     * Set the transit animation time
15275     *
15276     * @note @p transit can not be NULL
15277     *
15278     * @param transit The transit object.
15279     * @param duration The animation time.
15280     *
15281     * @ingroup Transit
15282     */
15283    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
15284
15285    /**
15286     * Get the transit animation time
15287     *
15288     * @note @p transit can not be NULL
15289     *
15290     * @param transit The transit object.
15291     *
15292     * @return The transit animation time.
15293     *
15294     * @ingroup Transit
15295     */
15296    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15297
15298    /**
15299     * Starts the transition.
15300     * Once this API is called, the transit begins to measure the time.
15301     *
15302     * @note @p transit can not be NULL
15303     *
15304     * @param transit The transit object.
15305     *
15306     * @ingroup Transit
15307     */
15308    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
15309
15310    /**
15311     * Pause/Resume the transition.
15312     *
15313     * If you call elm_transit_go again, the transit will be started from the
15314     * beginning, and will be unpaused.
15315     *
15316     * @note @p transit can not be NULL
15317     *
15318     * @param transit The transit object.
15319     * @param paused Whether the transition should be paused or not.
15320     *
15321     * @ingroup Transit
15322     */
15323    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
15324
15325    /**
15326     * Get the value of paused status.
15327     *
15328     * @see elm_transit_paused_set()
15329     *
15330     * @note @p transit can not be NULL
15331     *
15332     * @param transit The transit object.
15333     * @return EINA_TRUE means transition is paused. If @p transit is NULL
15334     * EINA_FALSE is returned
15335     *
15336     * @ingroup Transit
15337     */
15338    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15339
15340    /**
15341     * Get the time progression of the animation (a double value between 0.0 and 1.0).
15342     *
15343     * The value returned is a fraction (current time / total time). It
15344     * represents the progression position relative to the total.
15345     *
15346     * @note @p transit can not be NULL
15347     *
15348     * @param transit The transit object.
15349     *
15350     * @return The time progression value. If @p transit is NULL
15351     * 0 is returned
15352     *
15353     * @ingroup Transit
15354     */
15355    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
15356
15357    /**
15358     * Makes the chain relationship between two transits.
15359     *
15360     * @note @p transit can not be NULL. Transit would have multiple chain transits.
15361     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
15362     *
15363     * @param transit The transit object.
15364     * @param chain_transit The chain transit object. This transit will be operated
15365     *        after transit is done.
15366     *
15367     * This function adds @p chain_transit transition to a chain after the @p
15368     * transit, and will be started as soon as @p transit ends. See @ref
15369     * transit_example_02_explained for a full example.
15370     *
15371     * @ingroup Transit
15372     */
15373    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
15374
15375    /**
15376     * Cut off the chain relationship between two transits.
15377     *
15378     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
15379     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
15380     *
15381     * @param transit The transit object.
15382     * @param chain_transit The chain transit object.
15383     *
15384     * This function remove the @p chain_transit transition from the @p transit.
15385     *
15386     * @ingroup Transit
15387     */
15388    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
15389
15390    /**
15391     * Get the current chain transit list.
15392     *
15393     * @note @p transit can not be NULL.
15394     *
15395     * @param transit The transit object.
15396     * @return chain transit list.
15397     *
15398     * @ingroup Transit
15399     */
15400    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
15401
15402    /**
15403     * Add the Resizing Effect to Elm_Transit.
15404     *
15405     * @note This API is one of the facades. It creates resizing effect context
15406     * and add it's required APIs to elm_transit_effect_add.
15407     *
15408     * @see elm_transit_effect_add()
15409     *
15410     * @param transit Transit object.
15411     * @param from_w Object width size when effect begins.
15412     * @param from_h Object height size when effect begins.
15413     * @param to_w Object width size when effect ends.
15414     * @param to_h Object height size when effect ends.
15415     * @return Resizing effect context data.
15416     *
15417     * @ingroup Transit
15418     */
15419    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);
15420
15421    /**
15422     * Add the Translation Effect to Elm_Transit.
15423     *
15424     * @note This API is one of the facades. It creates translation effect context
15425     * and add it's required APIs to elm_transit_effect_add.
15426     *
15427     * @see elm_transit_effect_add()
15428     *
15429     * @param transit Transit object.
15430     * @param from_dx X Position variation when effect begins.
15431     * @param from_dy Y Position variation when effect begins.
15432     * @param to_dx X Position variation when effect ends.
15433     * @param to_dy Y Position variation when effect ends.
15434     * @return Translation effect context data.
15435     *
15436     * @ingroup Transit
15437     * @warning It is highly recommended just create a transit with this effect when
15438     * the window that the objects of the transit belongs has already been created.
15439     * This is because this effect needs the geometry information about the objects,
15440     * and if the window was not created yet, it can get a wrong information.
15441     */
15442    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);
15443
15444    /**
15445     * Add the Zoom Effect to Elm_Transit.
15446     *
15447     * @note This API is one of the facades. It creates zoom effect context
15448     * and add it's required APIs to elm_transit_effect_add.
15449     *
15450     * @see elm_transit_effect_add()
15451     *
15452     * @param transit Transit object.
15453     * @param from_rate Scale rate when effect begins (1 is current rate).
15454     * @param to_rate Scale rate when effect ends.
15455     * @return Zoom effect context data.
15456     *
15457     * @ingroup Transit
15458     * @warning It is highly recommended just create a transit with this effect when
15459     * the window that the objects of the transit belongs has already been created.
15460     * This is because this effect needs the geometry information about the objects,
15461     * and if the window was not created yet, it can get a wrong information.
15462     */
15463    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
15464
15465    /**
15466     * Add the Flip Effect to Elm_Transit.
15467     *
15468     * @note This API is one of the facades. It creates flip effect context
15469     * and add it's required APIs to elm_transit_effect_add.
15470     * @note This effect is applied to each pair of objects in the order they are listed
15471     * in the transit list of objects. The first object in the pair will be the
15472     * "front" object and the second will be the "back" object.
15473     *
15474     * @see elm_transit_effect_add()
15475     *
15476     * @param transit Transit object.
15477     * @param axis Flipping Axis(X or Y).
15478     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
15479     * @return Flip effect context data.
15480     *
15481     * @ingroup Transit
15482     * @warning It is highly recommended just create a transit with this effect when
15483     * the window that the objects of the transit belongs has already been created.
15484     * This is because this effect needs the geometry information about the objects,
15485     * and if the window was not created yet, it can get a wrong information.
15486     */
15487    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
15488
15489    /**
15490     * Add the Resizable Flip Effect to Elm_Transit.
15491     *
15492     * @note This API is one of the facades. It creates resizable flip effect context
15493     * and add it's required APIs to elm_transit_effect_add.
15494     * @note This effect is applied to each pair of objects in the order they are listed
15495     * in the transit list of objects. The first object in the pair will be the
15496     * "front" object and the second will be the "back" object.
15497     *
15498     * @see elm_transit_effect_add()
15499     *
15500     * @param transit Transit object.
15501     * @param axis Flipping Axis(X or Y).
15502     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
15503     * @return Resizable flip effect context data.
15504     *
15505     * @ingroup Transit
15506     * @warning It is highly recommended just create a transit with this effect when
15507     * the window that the objects of the transit belongs has already been created.
15508     * This is because this effect needs the geometry information about the objects,
15509     * and if the window was not created yet, it can get a wrong information.
15510     */
15511    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
15512
15513    /**
15514     * Add the Wipe Effect to Elm_Transit.
15515     *
15516     * @note This API is one of the facades. It creates wipe effect context
15517     * and add it's required APIs to elm_transit_effect_add.
15518     *
15519     * @see elm_transit_effect_add()
15520     *
15521     * @param transit Transit object.
15522     * @param type Wipe type. Hide or show.
15523     * @param dir Wipe Direction.
15524     * @return Wipe effect context data.
15525     *
15526     * @ingroup Transit
15527     * @warning It is highly recommended just create a transit with this effect when
15528     * the window that the objects of the transit belongs has already been created.
15529     * This is because this effect needs the geometry information about the objects,
15530     * and if the window was not created yet, it can get a wrong information.
15531     */
15532    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
15533
15534    /**
15535     * Add the Color Effect to Elm_Transit.
15536     *
15537     * @note This API is one of the facades. It creates color effect context
15538     * and add it's required APIs to elm_transit_effect_add.
15539     *
15540     * @see elm_transit_effect_add()
15541     *
15542     * @param transit        Transit object.
15543     * @param  from_r        RGB R when effect begins.
15544     * @param  from_g        RGB G when effect begins.
15545     * @param  from_b        RGB B when effect begins.
15546     * @param  from_a        RGB A when effect begins.
15547     * @param  to_r          RGB R when effect ends.
15548     * @param  to_g          RGB G when effect ends.
15549     * @param  to_b          RGB B when effect ends.
15550     * @param  to_a          RGB A when effect ends.
15551     * @return               Color effect context data.
15552     *
15553     * @ingroup Transit
15554     */
15555    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);
15556
15557    /**
15558     * Add the Fade Effect to Elm_Transit.
15559     *
15560     * @note This API is one of the facades. It creates fade effect context
15561     * and add it's required APIs to elm_transit_effect_add.
15562     * @note This effect is applied to each pair of objects in the order they are listed
15563     * in the transit list of objects. The first object in the pair will be the
15564     * "before" object and the second will be the "after" object.
15565     *
15566     * @see elm_transit_effect_add()
15567     *
15568     * @param transit Transit object.
15569     * @return Fade effect context data.
15570     *
15571     * @ingroup Transit
15572     * @warning It is highly recommended just create a transit with this effect when
15573     * the window that the objects of the transit belongs has already been created.
15574     * This is because this effect needs the color information about the objects,
15575     * and if the window was not created yet, it can get a wrong information.
15576     */
15577    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
15578
15579    /**
15580     * Add the Blend Effect to Elm_Transit.
15581     *
15582     * @note This API is one of the facades. It creates blend effect context
15583     * and add it's required APIs to elm_transit_effect_add.
15584     * @note This effect is applied to each pair of objects in the order they are listed
15585     * in the transit list of objects. The first object in the pair will be the
15586     * "before" object and the second will be the "after" object.
15587     *
15588     * @see elm_transit_effect_add()
15589     *
15590     * @param transit Transit object.
15591     * @return Blend effect context data.
15592     *
15593     * @ingroup Transit
15594     * @warning It is highly recommended just create a transit with this effect when
15595     * the window that the objects of the transit belongs has already been created.
15596     * This is because this effect needs the color information about the objects,
15597     * and if the window was not created yet, it can get a wrong information.
15598     */
15599    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
15600
15601    /**
15602     * Add the Rotation Effect to Elm_Transit.
15603     *
15604     * @note This API is one of the facades. It creates rotation effect context
15605     * and add it's required APIs to elm_transit_effect_add.
15606     *
15607     * @see elm_transit_effect_add()
15608     *
15609     * @param transit Transit object.
15610     * @param from_degree Degree when effect begins.
15611     * @param to_degree Degree when effect is ends.
15612     * @return Rotation effect context data.
15613     *
15614     * @ingroup Transit
15615     * @warning It is highly recommended just create a transit with this effect when
15616     * the window that the objects of the transit belongs has already been created.
15617     * This is because this effect needs the geometry information about the objects,
15618     * and if the window was not created yet, it can get a wrong information.
15619     */
15620    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
15621
15622    /**
15623     * Add the ImageAnimation Effect to Elm_Transit.
15624     *
15625     * @note This API is one of the facades. It creates image animation effect context
15626     * and add it's required APIs to elm_transit_effect_add.
15627     * The @p images parameter is a list images paths. This list and
15628     * its contents will be deleted at the end of the effect by
15629     * elm_transit_effect_image_animation_context_free() function.
15630     *
15631     * Example:
15632     * @code
15633     * char buf[PATH_MAX];
15634     * Eina_List *images = NULL;
15635     * Elm_Transit *transi = elm_transit_add();
15636     *
15637     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
15638     * images = eina_list_append(images, eina_stringshare_add(buf));
15639     *
15640     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
15641     * images = eina_list_append(images, eina_stringshare_add(buf));
15642     * elm_transit_effect_image_animation_add(transi, images);
15643     *
15644     * @endcode
15645     *
15646     * @see elm_transit_effect_add()
15647     *
15648     * @param transit Transit object.
15649     * @param images Eina_List of images file paths. This list and
15650     * its contents will be deleted at the end of the effect by
15651     * elm_transit_effect_image_animation_context_free() function.
15652     * @return Image Animation effect context data.
15653     *
15654     * @ingroup Transit
15655     */
15656    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
15657    /**
15658     * @}
15659     */
15660
15661    /* Store */
15662    typedef struct _Elm_Store                      Elm_Store;
15663    typedef struct _Elm_Store_DBsystem             Elm_Store_DBsystem;
15664    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
15665    typedef struct _Elm_Store_Item                 Elm_Store_Item;
15666    typedef struct _Elm_Store_Item_DBsystem        Elm_Store_Item_DBsystem;
15667    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
15668    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
15669    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
15670    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
15671    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
15672    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
15673    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
15674    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
15675
15676    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
15677    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
15678    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
15679    typedef void      (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
15680    typedef int       (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
15681    typedef void      (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
15682    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
15683
15684    typedef enum
15685      {
15686         ELM_STORE_ITEM_MAPPING_NONE = 0,
15687         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
15688         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
15689         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
15690         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
15691         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
15692         // can add more here as needed by common apps
15693         ELM_STORE_ITEM_MAPPING_LAST
15694      } Elm_Store_Item_Mapping_Type;
15695
15696    struct _Elm_Store_Item_Mapping_Icon
15697      {
15698         // FIXME: allow edje file icons
15699         int                   w, h;
15700         Elm_Icon_Lookup_Order lookup_order;
15701         Eina_Bool             standard_name : 1;
15702         Eina_Bool             no_scale : 1;
15703         Eina_Bool             smooth : 1;
15704         Eina_Bool             scale_up : 1;
15705         Eina_Bool             scale_down : 1;
15706      };
15707
15708    struct _Elm_Store_Item_Mapping_Empty
15709      {
15710         Eina_Bool             dummy;
15711      };
15712
15713    struct _Elm_Store_Item_Mapping_Photo
15714      {
15715         int                   size;
15716      };
15717
15718    struct _Elm_Store_Item_Mapping_Custom
15719      {
15720         Elm_Store_Item_Mapping_Cb func;
15721      };
15722
15723    struct _Elm_Store_Item_Mapping
15724      {
15725         Elm_Store_Item_Mapping_Type     type;
15726         const char                     *part;
15727         int                             offset;
15728         union
15729           {
15730              Elm_Store_Item_Mapping_Empty  empty;
15731              Elm_Store_Item_Mapping_Icon   icon;
15732              Elm_Store_Item_Mapping_Photo  photo;
15733              Elm_Store_Item_Mapping_Custom custom;
15734              // add more types here
15735           } details;
15736      };
15737
15738    struct _Elm_Store_Item_Info
15739      {
15740         int                           index;
15741         int                           item_type;
15742         int                           group_index;
15743         Eina_Bool                     rec_item;
15744         int                           pre_group_index;
15745
15746         Elm_Genlist_Item_Class       *item_class;
15747         const Elm_Store_Item_Mapping *mapping;
15748         void                         *data;
15749         char                         *sort_id;
15750      };
15751
15752    struct _Elm_Store_Item_Info_Filesystem
15753      {
15754         Elm_Store_Item_Info  base;
15755         char                *path;
15756      };
15757
15758 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
15759 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
15760
15761    EAPI Elm_Store              *elm_store_dbsystem_new(void);
15762    EAPI void                    elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
15763    EAPI void                    elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
15764    EAPI void                    elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
15765    EAPI void                    elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
15766    EAPI int                     elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15767    EAPI void                   *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15768    EAPI void                    elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
15769    EAPI int                     elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15770    EAPI Elm_Store_Item         *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
15771    EAPI void                    elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15772    EAPI void                    elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
15773    EAPI void                    elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15774    EAPI void                    elm_store_free(Elm_Store *st);
15775    EAPI Elm_Store              *elm_store_filesystem_new(void);
15776    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
15777    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15778    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15779    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
15780    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
15781    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15782    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15783    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15784    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
15785    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15786    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15787    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
15788    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
15789    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
15790    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15791    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15792    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
15793
15794    /* SegmentControl */
15795    typedef struct _Elm_Segment_Item Elm_Segment_Item;
15796    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15797    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
15798    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);
15799    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
15800    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15801    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15802    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15803    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15804    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
15805    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
15806    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
15807    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
15808    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
15809    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15810    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
15811    /* smart callbacks called:
15812     * "changed" -when the user clicks on a segment item which is not previously
15813     *            selected and get selected. The event_info parameter is the
15814     *            segment item index.
15815     */
15816
15817    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
15818    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
15819    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
15820    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
15821    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
15822    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
15823    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
15824    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
15825
15826    EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
15827    EAPI void         elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
15828
15829    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
15830    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
15831    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
15832    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
15833    EAPI void elm_video_play(Evas_Object *video);
15834    EAPI void elm_video_pause(Evas_Object *video);
15835    EAPI void elm_video_stop(Evas_Object *video);
15836    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
15837    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
15838    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
15839    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
15840    EAPI double elm_video_audio_level_get(Evas_Object *video);
15841    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
15842    EAPI double elm_video_play_position_get(Evas_Object *video);
15843    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
15844    EAPI double elm_video_play_length_get(Evas_Object *video);
15845    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
15846    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
15847    EAPI const char *elm_video_title_get(Evas_Object *video);
15848
15849    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
15850    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
15851
15852    // FIXME: incomplete - carousel. don't use this until this comment is removed
15853    typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
15854    EAPI Evas_Object       *elm_carousel_add(Evas_Object *parent);
15855    EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
15856    EAPI void               elm_carousel_item_del(Elm_Carousel_Item *item);
15857    EAPI void               elm_carousel_item_select(Elm_Carousel_Item *item);
15858    /* smart callbacks called:
15859     * "clicked" - when the user clicks on a carousel item and becomes selected
15860     */
15861
15862    /* datefield */
15863
15864    typedef enum _Elm_Datefield_ItemType
15865      {
15866         ELM_DATEFIELD_YEAR = 0,
15867         ELM_DATEFIELD_MONTH,
15868         ELM_DATEFIELD_DATE,
15869         ELM_DATEFIELD_HOUR,
15870         ELM_DATEFIELD_MINUTE,
15871         ELM_DATEFIELD_AMPM
15872      } Elm_Datefield_ItemType;
15873
15874    EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
15875    EAPI void         elm_datefield_format_set(Evas_Object *obj, const char *fmt);
15876    EAPI char        *elm_datefield_format_get(const Evas_Object *obj);
15877    EAPI void         elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
15878    EAPI Eina_Bool    elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
15879    EAPI void         elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
15880    EAPI int          elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
15881    EAPI void         elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
15882    EAPI int          elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
15883    EAPI Eina_Bool    elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
15884    EAPI void         elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
15885    EAPI int          elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
15886    EAPI Eina_Bool    elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
15887  
15888    /* smart callbacks called:
15889    * "changed" - when datefield value is changed, this signal is sent.
15890    */
15891
15892 ////////////////////// DEPRECATED ///////////////////////////////////
15893
15894    typedef enum _Elm_Datefield_Layout
15895      {
15896         ELM_DATEFIELD_LAYOUT_TIME,
15897         ELM_DATEFIELD_LAYOUT_DATE,
15898         ELM_DATEFIELD_LAYOUT_DATEANDTIME
15899      } Elm_Datefield_Layout;
15900
15901    EINA_DEPRECATED EAPI void         elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
15902    EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
15903    EINA_DEPRECATED EAPI void         elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
15904    EINA_DEPRECATED EAPI const char  *elm_datefield_date_format_get(const Evas_Object *obj);
15905    EINA_DEPRECATED EAPI void         elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
15906    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_time_mode_get(const Evas_Object *obj);
15907    EINA_DEPRECATED EAPI void         elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
15908    EINA_DEPRECATED EAPI void         elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
15909    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
15910    EINA_DEPRECATED EAPI void         elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
15911    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
15912    EINA_DEPRECATED EAPI void         elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
15913    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
15914    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
15915 /////////////////////////////////////////////////////////////////////
15916
15917    /* popup */
15918    typedef enum _Elm_Popup_Response
15919      {
15920         ELM_POPUP_RESPONSE_NONE = -1,
15921         ELM_POPUP_RESPONSE_TIMEOUT = -2,
15922         ELM_POPUP_RESPONSE_OK = -3,
15923         ELM_POPUP_RESPONSE_CANCEL = -4,
15924         ELM_POPUP_RESPONSE_CLOSE = -5
15925      } Elm_Popup_Response;
15926
15927    typedef enum _Elm_Popup_Mode
15928      {
15929         ELM_POPUP_TYPE_NONE = 0,
15930         ELM_POPUP_TYPE_ALERT = (1 << 0)
15931      } Elm_Popup_Mode;
15932
15933    typedef enum _Elm_Popup_Orient
15934      {
15935         ELM_POPUP_ORIENT_TOP,
15936         ELM_POPUP_ORIENT_CENTER,
15937         ELM_POPUP_ORIENT_BOTTOM,
15938         ELM_POPUP_ORIENT_LEFT,
15939         ELM_POPUP_ORIENT_RIGHT,
15940         ELM_POPUP_ORIENT_TOP_LEFT,
15941         ELM_POPUP_ORIENT_TOP_RIGHT,
15942         ELM_POPUP_ORIENT_BOTTOM_LEFT,
15943         ELM_POPUP_ORIENT_BOTTOM_RIGHT
15944      } Elm_Popup_Orient;
15945
15946    /* smart callbacks called:
15947     * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
15948     */
15949
15950    EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
15951    EAPI void         elm_popup_desc_set(Evas_Object *obj, const char *text);
15952    EAPI const char  *elm_popup_desc_get(Evas_Object *obj);
15953    EAPI void         elm_popup_title_label_set(Evas_Object *obj, const char *text);
15954    EAPI const char  *elm_popup_title_label_get(Evas_Object *obj);
15955    EAPI void         elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
15956    EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
15957    EAPI void         elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
15958    EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
15959    EAPI void         elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text,  ...);
15960    EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
15961    EAPI void         elm_popup_timeout_set(Evas_Object *obj, double timeout);
15962    EAPI void         elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
15963    EAPI void         elm_popup_response(Evas_Object *obj, int  response_id);
15964    EAPI void         elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
15965    EAPI int          elm_popup_run(Evas_Object *obj);
15966
15967    /* NavigationBar */
15968    #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
15969    #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
15970
15971    typedef enum
15972      {
15973         ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
15974         ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
15975         ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
15976         ELM_NAVIGATIONBAR_BACK_BUTTON
15977      } Elm_Navi_Button_Type;
15978
15979    EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
15980    EAPI void         elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
15981    EAPI void         elm_navigationbar_pop(Evas_Object *obj);
15982    EAPI void         elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
15983    EAPI void         elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
15984    EAPI const char  *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
15985    EAPI void         elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
15986    EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
15987    EAPI Eina_List   *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
15988    EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
15989    EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
15990    EAPI void         elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
15991    EAPI void         elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
15992    EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
15993    EAPI const char  *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
15994    EAPI void         elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
15995    EAPI void         elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
15996    EAPI void         elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
15997    EAPI void         elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
15998    Eina_Bool         elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
15999    EAPI void         elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
16000    EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
16001
16002    /* NavigationBar */
16003    #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
16004    #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
16005
16006    typedef enum
16007      {
16008         ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
16009         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
16010         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
16011         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
16012         ELM_NAVIGATIONBAR_EX_MAX
16013      } Elm_Navi_ex_Button_Type;
16014    typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
16015
16016    EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
16017    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
16018    EAPI void         elm_navigationbar_ex_item_pop(Evas_Object *obj);
16019    EAPI void         elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
16020    EAPI void         elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
16021    EAPI void         elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
16022    EAPI const char  *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
16023    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
16024    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
16025    EAPI void         elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
16026    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
16027    EAPI void         elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
16028    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
16029    EAPI void         elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
16030    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
16031    EAPI const char  *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
16032    EAPI void         elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
16033    EAPI void         elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
16034    EAPI const char  *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
16035    EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
16036    EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
16037    EAPI void         elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
16038    EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
16039    EAPI void         elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
16040    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
16041    EAPI void         elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
16042    EAPI void         elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
16043    Eina_Bool         elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
16044
16045   /* naviframe */
16046   #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
16047   #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
16048   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
16049   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
16050   #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
16051   #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
16052   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
16053   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
16054   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
16055   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
16056
16057   /**
16058     * @defgroup Naviframe Naviframe
16059     *
16060     * @brief Naviframe is a kind of view manager for the applications.
16061     *
16062     * Naviframe provides functions to switch different pages with stack
16063     * mechanism. It means if one page(item) needs to be changed to the new one,
16064     * then naviframe would push the new page to it's internal stack. Of course,
16065     * it can be back to the previous page by popping the top page. Naviframe
16066     * provides some transition effect while the pages are switching (same as
16067     * pager).
16068     *
16069     * Since each item could keep the different styles, users could keep the
16070     * same look & feel for the pages or different styles for the items in it's
16071     * application.
16072     *
16073     * Signals that you can add callback for are:
16074     *
16075     * @li "transition,finished" - When the transition is finished in changing
16076     *     the item
16077     * @li "title,clicked" - User clicked title area
16078     *
16079     * Default contents parts for the naviframe items that you can use for are:
16080     *
16081     * @li "elm.swallow.content" - The main content of the page
16082     * @li "elm.swallow.prev_btn" - The button to go to the previous page
16083     * @li "elm.swallow.next_btn" - The button to go to the next page
16084     *
16085     * Default text parts of naviframe items that you can be used are:
16086     *
16087     * @li "elm.text.title" - The title label in the title area
16088     *
16089     * @ref tutorial_naviframe gives a good overview of the usage of the API.
16090     * @{
16091     */
16092    /**
16093     * @brief Add a new Naviframe object to the parent.
16094     *
16095     * @param parent Parent object
16096     * @return New object or @c NULL, if it cannot be created
16097     */
16098    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16099    /**
16100     * @brief Push a new item to the top of the naviframe stack (and show it).
16101     *
16102     * @param obj The naviframe object
16103     * @param title_label The label in the title area. The name of the title
16104     *        label part is "elm.text.title"
16105     * @param prev_btn The button to go to the previous item. If it is NULL,
16106     *        then naviframe will create a back button automatically. The name of
16107     *        the prev_btn part is "elm.swallow.prev_btn"
16108     * @param next_btn The button to go to the next item. Or It could be just an
16109     *        extra function button. The name of the next_btn part is
16110     *        "elm.swallow.next_btn"
16111     * @param content The main content object. The name of content part is
16112     *        "elm.swallow.content"
16113     * @param item_style The current item style name. @c NULL would be default.
16114     * @return The created item or @c NULL upon failure.
16115     *
16116     * The item pushed becomes one page of the naviframe, this item will be
16117     * deleted when it is popped.
16118     *
16119     * @see also elm_naviframe_item_style_set()
16120     *
16121     * The following styles are available for this item:
16122     * @li @c "default"
16123     */
16124    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);
16125    /**
16126     * @brief Pop an item that is on top of the stack
16127     *
16128     * @param obj The naviframe object
16129     * @return @c NULL or the content object(if the
16130     *         elm_naviframe_content_preserve_on_pop_get is true).
16131     *
16132     * This pops an item that is on the top(visible) of the naviframe, makes it
16133     * disappear, then deletes the item. The item that was underneath it on the
16134     * stack will become visible.
16135     *
16136     * @see also elm_naviframe_content_preserve_on_pop_get()
16137     *
16138     * @ingroup Naviframe
16139     */
16140    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16141    /**
16142     * @brief Pop the items between the top and the above one on the given item.
16143     *
16144     * @param it The naviframe item
16145     *
16146     * @ingroup Naviframe
16147     */
16148    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16149    /**
16150    * Promote an item already in the naviframe stack to the top of the stack
16151    *
16152    * @param it The naviframe item
16153    *
16154    * This will take the indicated item and promote it to the top of the stack
16155    * as if it had been pushed there. The item must already be inside the
16156    * naviframe stack to work.
16157    *
16158    */
16159    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16160    /**
16161     * @brief Delete the given item instantly.
16162     *
16163     * @param it The naviframe item
16164     *
16165     * This just deletes the given item from the naviframe item list instantly.
16166     * So this would not emit any signals for view transitions but just change
16167     * the current view if the given item is a top one.
16168     *
16169     * @ingroup Naviframe
16170     */
16171    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16172    /**
16173     * @brief preserve the content objects when items are popped.
16174     *
16175     * @param obj The naviframe object
16176     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
16177     *
16178     * @see also elm_naviframe_content_preserve_on_pop_get()
16179     *
16180     * @ingroup Naviframe
16181     */
16182    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
16183    /**
16184     * @brief Get a value whether preserve mode is enabled or not.
16185     *
16186     * @param obj The naviframe object
16187     * @return If @c EINA_TRUE, preserve mode is enabled
16188     *
16189     * @see also elm_naviframe_content_preserve_on_pop_set()
16190     *
16191     * @ingroup Naviframe
16192     */
16193    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16194    /**
16195     * @brief Get a top item on the naviframe stack
16196     *
16197     * @param obj The naviframe object
16198     * @return The top item on the naviframe stack or @c NULL, if the stack is
16199     *         empty
16200     *
16201     * @ingroup Naviframe
16202     */
16203    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16204    /**
16205     * @brief Get a bottom item on the naviframe stack
16206     *
16207     * @param obj The naviframe object
16208     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
16209     *         empty
16210     *
16211     * @ingroup Naviframe
16212     */
16213    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16214    /**
16215     * @brief Set an item style
16216     *
16217     * @param obj The naviframe item
16218     * @param item_style The current item style name. @c NULL would be default
16219     *
16220     * The following styles are available for this item:
16221     * @li @c "default"
16222     *
16223     * @see also elm_naviframe_item_style_get()
16224     *
16225     * @ingroup Naviframe
16226     */
16227    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
16228    /**
16229     * @brief Get an item style
16230     *
16231     * @param obj The naviframe item
16232     * @return The current item style name
16233     *
16234     * @see also elm_naviframe_item_style_set()
16235     *
16236     * @ingroup Naviframe
16237     */
16238    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16239    /**
16240     * @brief Show/Hide the title area
16241     *
16242     * @param it The naviframe item
16243     * @param visible If @c EINA_TRUE, title area will be visible, hidden
16244     *        otherwise
16245     *
16246     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
16247     *
16248     * @see also elm_naviframe_item_title_visible_get()
16249     *
16250     * @ingroup Naviframe
16251     */
16252    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
16253    /**
16254     * @brief Get a value whether title area is visible or not.
16255     *
16256     * @param it The naviframe item
16257     * @return If @c EINA_TRUE, title area is visible
16258     *
16259     * @see also elm_naviframe_item_title_visible_set()
16260     *
16261     * @ingroup Naviframe
16262     */
16263    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16264
16265    /**
16266     * @brief Set creating prev button automatically or not
16267     *
16268     * @param obj The naviframe object
16269     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
16270     *        be created internally when you pass the @c NULL to the prev_btn
16271     *        parameter in elm_naviframe_item_push
16272     *
16273     * @see also elm_naviframe_item_push()
16274     */
16275    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
16276    /**
16277     * @brief Get a value whether prev button(back button) will be auto pushed or
16278     *        not.
16279     *
16280     * @param obj The naviframe object
16281     * @return If @c EINA_TRUE, prev button will be auto pushed.
16282     *
16283     * @see also elm_naviframe_item_push()
16284     *           elm_naviframe_prev_btn_auto_pushed_set()
16285     */
16286    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
16287
16288    /* Control Bar */
16289    #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
16290    #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
16291    #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
16292    #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
16293    #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
16294    #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
16295    #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
16296    #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
16297    #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
16298
16299    typedef enum _Elm_Controlbar_Mode_Type
16300      {
16301         ELM_CONTROLBAR_MODE_DEFAULT = 0,
16302         ELM_CONTROLBAR_MODE_TRANSLUCENCE,
16303         ELM_CONTROLBAR_MODE_TRANSPARENCY,
16304         ELM_CONTROLBAR_MODE_LARGE,
16305         ELM_CONTROLBAR_MODE_SMALL,
16306         ELM_CONTROLBAR_MODE_LEFT,
16307         ELM_CONTROLBAR_MODE_RIGHT
16308      } Elm_Controlbar_Mode_Type;
16309
16310    typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
16311    EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
16312    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
16313    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
16314    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
16315    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
16316    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
16317    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
16318    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
16319    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
16320    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
16321    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
16322    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
16323    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
16324    EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
16325    EAPI void         elm_controlbar_item_del(Elm_Controlbar_Item *it);
16326    EAPI void         elm_controlbar_item_select(Elm_Controlbar_Item *it);
16327    EAPI void         elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
16328    EAPI Eina_Bool    elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
16329    EAPI void         elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
16330    EAPI Eina_Bool    elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
16331    EAPI void         elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
16332    EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
16333    EAPI void         elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
16334    EAPI const char  *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
16335    EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
16336    EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
16337    EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
16338    EAPI const Eina_List   *elm_controlbar_items_get(const Evas_Object *obj);
16339    EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
16340    EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
16341    EAPI void         elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
16342    EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
16343    EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
16344    EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
16345    EAPI void         elm_controlbar_mode_set(Evas_Object *obj, int mode);
16346    EAPI void         elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
16347    EAPI void         elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
16348    EAPI void         elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
16349
16350    /* SearchBar */
16351    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
16352    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
16353    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
16354    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
16355    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
16356    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
16357    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
16358    EAPI void         elm_searchbar_clear(Evas_Object *obj);
16359    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
16360
16361    EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
16362    EAPI void         elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
16363    EAPI void         elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
16364    EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
16365
16366    /* NoContents */
16367    EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
16368    EAPI void         elm_nocontents_label_set(Evas_Object *obj, const char *label);
16369    EAPI const char  *elm_nocontents_label_get(const Evas_Object *obj);
16370    EAPI void         elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
16371    EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
16372
16373    /* TickerNoti */
16374    typedef enum
16375      {
16376         ELM_TICKERNOTI_ORIENT_TOP = 0,
16377         ELM_TICKERNOTI_ORIENT_BOTTOM,
16378         ELM_TICKERNOTI_ORIENT_LAST
16379      }  Elm_Tickernoti_Orient;
16380
16381    EAPI Evas_Object              *elm_tickernoti_add (Evas_Object *parent);
16382    EAPI void                      elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
16383    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16384    EAPI int                       elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16385    EAPI void                      elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
16386    EAPI Evas_Object              *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16387    /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
16388    typedef enum
16389     {
16390        ELM_TICKERNOTI_DEFAULT,
16391        ELM_TICKERNOTI_DETAILVIEW
16392     } Elm_Tickernoti_Mode;
16393    EAPI void                      elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16394    EAPI const char               *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
16395    EAPI void                      elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
16396    EAPI Evas_Object              *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16397    EAPI void                      elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16398    EAPI Evas_Object              *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16399    EAPI Evas_Object              *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16400    EAPI void                      elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
16401    EAPI Elm_Tickernoti_Mode       elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16402    EAPI void                      elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
16403    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16404    EAPI void                      elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16405    EAPI const char               *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16406    EAPI void                      elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16407    EAPI Evas_Object              *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16408    EAPI void                      elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
16409    EAPI Evas_Object              *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
16410    /* ############################################################################### */
16411    /*
16412     * Parts which can be used with elm_object_text_part_set() and
16413     * elm_object_text_part_get():
16414     *
16415     * @li NULL/"default" - Operates on tickernoti content-text
16416     *
16417     * Parts which can be used with elm_object_content_part_set() and
16418     * elm_object_content_part_get():
16419     *
16420     * @li "icon" - Operates on tickernoti's icon
16421     * @li "button" - Operates on tickernoti's button
16422     *
16423     * smart callbacks called:
16424     * @li "clicked" - emitted when tickernoti is clicked, except at the
16425     * swallow/button region, if any.
16426     * @li "hide" - emitted when the tickernoti is completely hidden. In case of
16427     * any hide animation, this signal is emitted after the animation.
16428     */
16429
16430    /* colorpalette */
16431    typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
16432
16433    struct _Colorpalette_Color
16434      {
16435         unsigned int r, g, b;
16436      };
16437
16438    EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
16439    EAPI void         elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
16440    EAPI void         elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
16441    /* smart callbacks called:
16442     * "clicked" - when image clicked
16443     */
16444
16445    /* editfield */
16446    EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
16447    EAPI void         elm_editfield_label_set(Evas_Object *obj, const char *label);
16448    EAPI const char  *elm_editfield_label_get(Evas_Object *obj);
16449    EAPI void         elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
16450    EAPI const char  *elm_editfield_guide_text_get(Evas_Object *obj);
16451    EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
16452 //   EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
16453    EAPI void         elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
16454    EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
16455    EAPI void         elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
16456    EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
16457    EAPI void         elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
16458    EAPI Eina_Bool    elm_editfield_entry_single_line_get(Evas_Object *obj);
16459    EAPI void         elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
16460    EAPI Eina_Bool    elm_editfield_eraser_get(Evas_Object *obj);
16461    /* smart callbacks called:
16462     * "clicked" - when an editfield is clicked
16463     * "unfocused" - when an editfield is unfocused
16464     */
16465
16466
16467    /* Sliding Drawer */
16468    typedef enum _Elm_SlidingDrawer_Pos
16469      {
16470         ELM_SLIDINGDRAWER_BOTTOM,
16471         ELM_SLIDINGDRAWER_LEFT,
16472         ELM_SLIDINGDRAWER_RIGHT,
16473         ELM_SLIDINGDRAWER_TOP
16474      } Elm_SlidingDrawer_Pos;
16475
16476    typedef struct _Elm_SlidingDrawer_Drag_Value
16477      {
16478         double x, y;
16479      } Elm_SlidingDrawer_Drag_Value;
16480
16481    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
16482    EINA_DEPRECATED EAPI void         elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
16483    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
16484    EINA_DEPRECATED EAPI void         elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
16485    EINA_DEPRECATED EAPI void         elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw,  double dh);
16486    EINA_DEPRECATED EAPI void         elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
16487
16488    /* multibuttonentry */
16489    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
16490    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
16491    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent);
16492    EAPI const char                *elm_multibuttonentry_label_get(Evas_Object *obj);
16493    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
16494    EAPI Evas_Object               *elm_multibuttonentry_entry_get(Evas_Object *obj);
16495    EAPI const char *               elm_multibuttonentry_guide_text_get(Evas_Object *obj);
16496    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
16497    EAPI int                        elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
16498    EAPI void                       elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
16499    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
16500    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
16501    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
16502    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
16503    EAPI const Eina_List           *elm_multibuttonentry_items_get(Evas_Object *obj);
16504    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
16505    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
16506    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
16507    EAPI void                       elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
16508    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
16509    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
16510    EAPI void                       elm_multibuttonentry_items_del(Evas_Object *obj);
16511    EAPI const char                *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
16512    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
16513    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
16514    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
16515    EAPI void                      *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
16516    EAPI void                       elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
16517    EAPI void                       elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
16518    /* smart callback called:
16519     * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
16520     * "added" - This signal is emitted when a new multibuttonentry item is added.
16521     * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
16522     * "expanded" - This signal is emitted when a multibuttonentry is expanded.
16523     * "contracted" - This signal is emitted when a multibuttonentry is contracted.
16524     * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
16525     * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
16526     * "item,added" - This signal is emitted when a new multibuttonentry item is added.
16527     * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
16528     * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
16529     * "clicked" - This signal is emitted when a multibuttonentry is clicked.
16530     * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
16531     */
16532    /* available styles:
16533     * default
16534     */
16535
16536    /* stackedicon */
16537    typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
16538    EAPI Evas_Object          *elm_stackedicon_add(Evas_Object *parent);
16539    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
16540    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
16541    EAPI void                  elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
16542    EAPI Eina_List            *elm_stackedicon_item_list_get(Evas_Object *obj);
16543    /* smart callback called:
16544     * "expanded" - This signal is emitted when a stackedicon is expanded.
16545     * "clicked" - This signal is emitted when a stackedicon is clicked.
16546     */
16547    /* available styles:
16548     * default
16549     */
16550
16551    /* dialoguegroup */
16552    typedef struct _Dialogue_Item Dialogue_Item;
16553
16554    typedef enum _Elm_Dialoguegourp_Item_Style
16555      {
16556         ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
16557         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
16558         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
16559         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
16560         ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
16561         ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
16562         ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
16563         ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
16564         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
16565         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
16566         ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
16567      } Elm_Dialoguegroup_Item_Style;
16568
16569    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_add(Evas_Object *parent);
16570    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
16571    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
16572    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
16573    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
16574    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove(Dialogue_Item *item);
16575    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove_all(Evas_Object *obj);
16576    EINA_DEPRECATED EAPI void           elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
16577    EINA_DEPRECATED EAPI const char    *elm_dialoguegroup_title_get(Evas_Object *obj);
16578    EINA_DEPRECATED EAPI void           elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
16579    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
16580    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
16581    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
16582    EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style    elm_dialoguegroup_item_style_get(Dialogue_Item *item);
16583    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
16584    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
16585
16586    /* Dayselector */
16587    typedef enum
16588      {
16589         ELM_DAYSELECTOR_SUN,
16590         ELM_DAYSELECTOR_MON,
16591         ELM_DAYSELECTOR_TUE,
16592         ELM_DAYSELECTOR_WED,
16593         ELM_DAYSELECTOR_THU,
16594         ELM_DAYSELECTOR_FRI,
16595         ELM_DAYSELECTOR_SAT
16596      } Elm_DaySelector_Day;
16597
16598    EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
16599    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
16600    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
16601
16602    /* Image Slider */
16603    typedef struct _Imageslider_Item Elm_Imageslider_Item;
16604    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
16605    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16606    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
16607    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
16608    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
16609    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
16610    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16611    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
16612    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
16613    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
16614    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
16615    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
16616    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
16617    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16618    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
16619    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
16620 #ifdef __cplusplus
16621 }
16622 #endif
16623
16624 #endif