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