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