[Elementary.h] 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    /**
3071     * Get the duration for occuring long press event.
3072     *
3073     * @return Timeout for long press event
3074     * @ingroup Longpress
3075     */
3076    EAPI double           elm_longpress_timeout_get(void);
3077
3078    /**
3079     * Set the duration for occuring long press event.
3080     *
3081     * @param lonpress_timeout Timeout for long press event
3082     * @ingroup Longpress
3083     */
3084    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3085
3086    /**
3087     * @defgroup Debug Debug
3088     * don't use it unless you are sure
3089     *
3090     * @{
3091     */
3092
3093    /**
3094     * Print Tree object hierarchy in stdout
3095     *
3096     * @param obj The root object
3097     * @ingroup Debug
3098     */
3099    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3100    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3101
3102    EAPI void             elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3103    EAPI void             elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3104    /**
3105     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3106     *
3107     * @param obj The root object
3108     * @param file The path of output file
3109     * @ingroup Debug
3110     */
3111    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3112
3113    /**
3114     * @}
3115     */
3116
3117    /**
3118     * @defgroup Theme Theme
3119     *
3120     * Elementary uses Edje to theme its widgets, naturally. But for the most
3121     * part this is hidden behind a simpler interface that lets the user set
3122     * extensions and choose the style of widgets in a much easier way.
3123     *
3124     * Instead of thinking in terms of paths to Edje files and their groups
3125     * each time you want to change the appearance of a widget, Elementary
3126     * works so you can add any theme file with extensions or replace the
3127     * main theme at one point in the application, and then just set the style
3128     * of widgets with elm_object_style_set() and related functions. Elementary
3129     * will then look in its list of themes for a matching group and apply it,
3130     * and when the theme changes midway through the application, all widgets
3131     * will be updated accordingly.
3132     *
3133     * There are three concepts you need to know to understand how Elementary
3134     * theming works: default theme, extensions and overlays.
3135     *
3136     * Default theme, obviously enough, is the one that provides the default
3137     * look of all widgets. End users can change the theme used by Elementary
3138     * by setting the @c ELM_THEME environment variable before running an
3139     * application, or globally for all programs using the @c elementary_config
3140     * utility. Applications can change the default theme using elm_theme_set(),
3141     * but this can go against the user wishes, so it's not an adviced practice.
3142     *
3143     * Ideally, applications should find everything they need in the already
3144     * provided theme, but there may be occasions when that's not enough and
3145     * custom styles are required to correctly express the idea. For this
3146     * cases, Elementary has extensions.
3147     *
3148     * Extensions allow the application developer to write styles of its own
3149     * to apply to some widgets. This requires knowledge of how each widget
3150     * is themed, as extensions will always replace the entire group used by
3151     * the widget, so important signals and parts need to be there for the
3152     * object to behave properly (see documentation of Edje for details).
3153     * Once the theme for the extension is done, the application needs to add
3154     * it to the list of themes Elementary will look into, using
3155     * elm_theme_extension_add(), and set the style of the desired widgets as
3156     * he would normally with elm_object_style_set().
3157     *
3158     * Overlays, on the other hand, can replace the look of all widgets by
3159     * overriding the default style. Like extensions, it's up to the application
3160     * developer to write the theme for the widgets it wants, the difference
3161     * being that when looking for the theme, Elementary will check first the
3162     * list of overlays, then the set theme and lastly the list of extensions,
3163     * so with overlays it's possible to replace the default view and every
3164     * widget will be affected. This is very much alike to setting the whole
3165     * theme for the application and will probably clash with the end user
3166     * options, not to mention the risk of ending up with not matching styles
3167     * across the program. Unless there's a very special reason to use them,
3168     * overlays should be avoided for the resons exposed before.
3169     *
3170     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3171     * keeps one default internally and every function that receives one of
3172     * these can be called with NULL to refer to this default (except for
3173     * elm_theme_free()). It's possible to create a new instance of a
3174     * ::Elm_Theme to set other theme for a specific widget (and all of its
3175     * children), but this is as discouraged, if not even more so, than using
3176     * overlays. Don't use this unless you really know what you are doing.
3177     *
3178     * But to be less negative about things, you can look at the following
3179     * examples:
3180     * @li @ref theme_example_01 "Using extensions"
3181     * @li @ref theme_example_02 "Using overlays"
3182     *
3183     * @{
3184     */
3185    /**
3186     * @typedef Elm_Theme
3187     *
3188     * Opaque handler for the list of themes Elementary looks for when
3189     * rendering widgets.
3190     *
3191     * Stay out of this unless you really know what you are doing. For most
3192     * cases, sticking to the default is all a developer needs.
3193     */
3194    typedef struct _Elm_Theme Elm_Theme;
3195
3196    /**
3197     * Create a new specific theme
3198     *
3199     * This creates an empty specific theme that only uses the default theme. A
3200     * specific theme has its own private set of extensions and overlays too
3201     * (which are empty by default). Specific themes do not fall back to themes
3202     * of parent objects. They are not intended for this use. Use styles, overlays
3203     * and extensions when needed, but avoid specific themes unless there is no
3204     * other way (example: you want to have a preview of a new theme you are
3205     * selecting in a "theme selector" window. The preview is inside a scroller
3206     * and should display what the theme you selected will look like, but not
3207     * actually apply it yet. The child of the scroller will have a specific
3208     * theme set to show this preview before the user decides to apply it to all
3209     * applications).
3210     */
3211    EAPI Elm_Theme       *elm_theme_new(void);
3212    /**
3213     * Free a specific theme
3214     *
3215     * @param th The theme to free
3216     *
3217     * This frees a theme created with elm_theme_new().
3218     */
3219    EAPI void             elm_theme_free(Elm_Theme *th);
3220    /**
3221     * Copy the theme fom the source to the destination theme
3222     *
3223     * @param th The source theme to copy from
3224     * @param thdst The destination theme to copy data to
3225     *
3226     * This makes a one-time static copy of all the theme config, extensions
3227     * and overlays from @p th to @p thdst. If @p th references a theme, then
3228     * @p thdst is also set to reference it, with all the theme settings,
3229     * overlays and extensions that @p th had.
3230     */
3231    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3232    /**
3233     * Tell the source theme to reference the ref theme
3234     *
3235     * @param th The theme that will do the referencing
3236     * @param thref The theme that is the reference source
3237     *
3238     * This clears @p th to be empty and then sets it to refer to @p thref
3239     * so @p th acts as an override to @p thref, but where its overrides
3240     * don't apply, it will fall through to @p thref for configuration.
3241     */
3242    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3243    /**
3244     * Return the theme referred to
3245     *
3246     * @param th The theme to get the reference from
3247     * @return The referenced theme handle
3248     *
3249     * This gets the theme set as the reference theme by elm_theme_ref_set().
3250     * If no theme is set as a reference, NULL is returned.
3251     */
3252    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3253    /**
3254     * Return the default theme
3255     *
3256     * @return The default theme handle
3257     *
3258     * This returns the internal default theme setup handle that all widgets
3259     * use implicitly unless a specific theme is set. This is also often use
3260     * as a shorthand of NULL.
3261     */
3262    EAPI Elm_Theme       *elm_theme_default_get(void);
3263    /**
3264     * Prepends a theme overlay to the list of overlays
3265     *
3266     * @param th The theme to add to, or if NULL, the default theme
3267     * @param item The Edje file path to be used
3268     *
3269     * Use this if your application needs to provide some custom overlay theme
3270     * (An Edje file that replaces some default styles of widgets) where adding
3271     * new styles, or changing system theme configuration is not possible. Do
3272     * NOT use this instead of a proper system theme configuration. Use proper
3273     * configuration files, profiles, environment variables etc. to set a theme
3274     * so that the theme can be altered by simple confiugration by a user. Using
3275     * this call to achieve that effect is abusing the API and will create lots
3276     * of trouble.
3277     *
3278     * @see elm_theme_extension_add()
3279     */
3280    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3281    /**
3282     * Delete a theme overlay from the list of overlays
3283     *
3284     * @param th The theme to delete from, or if NULL, the default theme
3285     * @param item The name of the theme overlay
3286     *
3287     * @see elm_theme_overlay_add()
3288     */
3289    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3290    /**
3291     * Appends a theme extension to the list of extensions.
3292     *
3293     * @param th The theme to add to, or if NULL, the default theme
3294     * @param item The Edje file path to be used
3295     *
3296     * This is intended when an application needs more styles of widgets or new
3297     * widget themes that the default does not provide (or may not provide). The
3298     * application has "extended" usage by coming up with new custom style names
3299     * for widgets for specific uses, but as these are not "standard", they are
3300     * not guaranteed to be provided by a default theme. This means the
3301     * application is required to provide these extra elements itself in specific
3302     * Edje files. This call adds one of those Edje files to the theme search
3303     * path to be search after the default theme. The use of this call is
3304     * encouraged when default styles do not meet the needs of the application.
3305     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3306     *
3307     * @see elm_object_style_set()
3308     */
3309    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3310    /**
3311     * Deletes a theme extension from the list of extensions.
3312     *
3313     * @param th The theme to delete from, or if NULL, the default theme
3314     * @param item The name of the theme extension
3315     *
3316     * @see elm_theme_extension_add()
3317     */
3318    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3319    /**
3320     * Set the theme search order for the given theme
3321     *
3322     * @param th The theme to set the search order, or if NULL, the default theme
3323     * @param theme Theme search string
3324     *
3325     * This sets the search string for the theme in path-notation from first
3326     * theme to search, to last, delimited by the : character. Example:
3327     *
3328     * "shiny:/path/to/file.edj:default"
3329     *
3330     * See the ELM_THEME environment variable for more information.
3331     *
3332     * @see elm_theme_get()
3333     * @see elm_theme_list_get()
3334     */
3335    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3336    /**
3337     * Return the theme search order
3338     *
3339     * @param th The theme to get the search order, or if NULL, the default theme
3340     * @return The internal search order path
3341     *
3342     * This function returns a colon separated string of theme elements as
3343     * returned by elm_theme_list_get().
3344     *
3345     * @see elm_theme_set()
3346     * @see elm_theme_list_get()
3347     */
3348    EAPI const char      *elm_theme_get(Elm_Theme *th);
3349    /**
3350     * Return a list of theme elements to be used in a theme.
3351     *
3352     * @param th Theme to get the list of theme elements from.
3353     * @return The internal list of theme elements
3354     *
3355     * This returns the internal list of theme elements (will only be valid as
3356     * long as the theme is not modified by elm_theme_set() or theme is not
3357     * freed by elm_theme_free(). This is a list of strings which must not be
3358     * altered as they are also internal. If @p th is NULL, then the default
3359     * theme element list is returned.
3360     *
3361     * A theme element can consist of a full or relative path to a .edj file,
3362     * or a name, without extension, for a theme to be searched in the known
3363     * theme paths for Elemementary.
3364     *
3365     * @see elm_theme_set()
3366     * @see elm_theme_get()
3367     */
3368    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3369    /**
3370     * Return the full patrh for a theme element
3371     *
3372     * @param f The theme element name
3373     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3374     * @return The full path to the file found.
3375     *
3376     * This returns a string you should free with free() on success, NULL on
3377     * failure. This will search for the given theme element, and if it is a
3378     * full or relative path element or a simple searchable name. The returned
3379     * path is the full path to the file, if searched, and the file exists, or it
3380     * is simply the full path given in the element or a resolved path if
3381     * relative to home. The @p in_search_path boolean pointed to is set to
3382     * EINA_TRUE if the file was a searchable file andis in the search path,
3383     * and EINA_FALSE otherwise.
3384     */
3385    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3386    /**
3387     * Flush the current theme.
3388     *
3389     * @param th Theme to flush
3390     *
3391     * This flushes caches that let elementary know where to find theme elements
3392     * in the given theme. If @p th is NULL, then the default theme is flushed.
3393     * Call this function if source theme data has changed in such a way as to
3394     * make any caches Elementary kept invalid.
3395     */
3396    EAPI void             elm_theme_flush(Elm_Theme *th);
3397    /**
3398     * This flushes all themes (default and specific ones).
3399     *
3400     * This will flush all themes in the current application context, by calling
3401     * elm_theme_flush() on each of them.
3402     */
3403    EAPI void             elm_theme_full_flush(void);
3404    /**
3405     * Set the theme for all elementary using applications on the current display
3406     *
3407     * @param theme The name of the theme to use. Format same as the ELM_THEME
3408     * environment variable.
3409     */
3410    EAPI void             elm_theme_all_set(const char *theme);
3411    /**
3412     * Return a list of theme elements in the theme search path
3413     *
3414     * @return A list of strings that are the theme element names.
3415     *
3416     * This lists all available theme files in the standard Elementary search path
3417     * for theme elements, and returns them in alphabetical order as theme
3418     * element names in a list of strings. Free this with
3419     * elm_theme_name_available_list_free() when you are done with the list.
3420     */
3421    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3422    /**
3423     * Free the list returned by elm_theme_name_available_list_new()
3424     *
3425     * This frees the list of themes returned by
3426     * elm_theme_name_available_list_new(). Once freed the list should no longer
3427     * be used. a new list mys be created.
3428     */
3429    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3430    /**
3431     * Set a specific theme to be used for this object and its children
3432     *
3433     * @param obj The object to set the theme on
3434     * @param th The theme to set
3435     *
3436     * This sets a specific theme that will be used for the given object and any
3437     * child objects it has. If @p th is NULL then the theme to be used is
3438     * cleared and the object will inherit its theme from its parent (which
3439     * ultimately will use the default theme if no specific themes are set).
3440     *
3441     * Use special themes with great care as this will annoy users and make
3442     * configuration difficult. Avoid any custom themes at all if it can be
3443     * helped.
3444     */
3445    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3446    /**
3447     * Get the specific theme to be used
3448     *
3449     * @param obj The object to get the specific theme from
3450     * @return The specifc theme set.
3451     *
3452     * This will return a specific theme set, or NULL if no specific theme is
3453     * set on that object. It will not return inherited themes from parents, only
3454     * the specific theme set for that specific object. See elm_object_theme_set()
3455     * for more information.
3456     */
3457    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3458
3459    /**
3460     * Get a data item from a theme
3461     *
3462     * @param th The theme, or NULL for default theme
3463     * @param key The data key to search with
3464     * @return The data value, or NULL on failure
3465     *
3466     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3467     * It works the same way as edje_file_data_get() except that the return is stringshared.
3468     */
3469    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3470    /**
3471     * @}
3472     */
3473
3474    /* win */
3475    /** @defgroup Win Win
3476     *
3477     * @image html img/widget/win/preview-00.png
3478     * @image latex img/widget/win/preview-00.eps
3479     *
3480     * The window class of Elementary.  Contains functions to manipulate
3481     * windows. The Evas engine used to render the window contents is specified
3482     * in the system or user elementary config files (whichever is found last),
3483     * and can be overridden with the ELM_ENGINE environment variable for
3484     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3485     * compilation setup and modules actually installed at runtime) are (listed
3486     * in order of best supported and most likely to be complete and work to
3487     * lowest quality).
3488     *
3489     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3490     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3491     * rendering in X11)
3492     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3493     * exits)
3494     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3495     * rendering)
3496     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3497     * buffer)
3498     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3499     * rendering using SDL as the buffer)
3500     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3501     * GDI with software)
3502     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3503     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3504     * grayscale using dedicated 8bit software engine in X11)
3505     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3506     * X11 using 16bit software engine)
3507     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3508     * (Windows CE rendering via GDI with 16bit software renderer)
3509     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3510     * buffer with 16bit software renderer)
3511     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3512     *
3513     * All engines use a simple string to select the engine to render, EXCEPT
3514     * the "shot" engine. This actually encodes the output of the virtual
3515     * screenshot and how long to delay in the engine string. The engine string
3516     * is encoded in the following way:
3517     *
3518     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3519     *
3520     * Where options are separated by a ":" char if more than one option is
3521     * given, with delay, if provided being the first option and file the last
3522     * (order is important). The delay specifies how long to wait after the
3523     * window is shown before doing the virtual "in memory" rendering and then
3524     * save the output to the file specified by the file option (and then exit).
3525     * If no delay is given, the default is 0.5 seconds. If no file is given the
3526     * default output file is "out.png". Repeat option is for continous
3527     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3528     * fixed to "out001.png" Some examples of using the shot engine:
3529     *
3530     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3531     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3532     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3533     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3534     *   ELM_ENGINE="shot:" elementary_test
3535     *
3536     * Signals that you can add callbacks for are:
3537     *
3538     * @li "delete,request": the user requested to close the window. See
3539     * elm_win_autodel_set().
3540     * @li "focus,in": window got focus
3541     * @li "focus,out": window lost focus
3542     * @li "moved": window that holds the canvas was moved
3543     *
3544     * Examples:
3545     * @li @ref win_example_01
3546     *
3547     * @{
3548     */
3549    /**
3550     * Defines the types of window that can be created
3551     *
3552     * These are hints set on the window so that a running Window Manager knows
3553     * how the window should be handled and/or what kind of decorations it
3554     * should have.
3555     *
3556     * Currently, only the X11 backed engines use them.
3557     */
3558    typedef enum _Elm_Win_Type
3559      {
3560         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3561                          window. Almost every window will be created with this
3562                          type. */
3563         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3564         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3565                            window holding desktop icons. */
3566         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3567                         be kept on top of any other window by the Window
3568                         Manager. */
3569         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3570                            similar. */
3571         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3572         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3573                            pallete. */
3574         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3575         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3576                                  entry in a menubar is clicked. Typically used
3577                                  with elm_win_override_set(). This hint exists
3578                                  for completion only, as the EFL way of
3579                                  implementing a menu would not normally use a
3580                                  separate window for its contents. */
3581         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3582                               triggered by right-clicking an object. */
3583         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3584                            explanatory text that typically appear after the
3585                            mouse cursor hovers over an object for a while.
3586                            Typically used with elm_win_override_set() and also
3587                            not very commonly used in the EFL. */
3588         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3589                                 battery life or a new E-Mail received. */
3590         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3591                          usually used in the EFL. */
3592         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3593                        object being dragged across different windows, or even
3594                        applications. Typically used with
3595                        elm_win_override_set(). */
3596         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3597                                  buffer. No actual window is created for this
3598                                  type, instead the window and all of its
3599                                  contents will be rendered to an image buffer.
3600                                  This allows to have children window inside a
3601                                  parent one just like any other object would
3602                                  be, and do other things like applying @c
3603                                  Evas_Map effects to it. This is the only type
3604                                  of window that requires the @c parent
3605                                  parameter of elm_win_add() to be a valid @c
3606                                  Evas_Object. */
3607      } Elm_Win_Type;
3608
3609    /**
3610     * The differents layouts that can be requested for the virtual keyboard.
3611     *
3612     * When the application window is being managed by Illume, it may request
3613     * any of the following layouts for the virtual keyboard.
3614     */
3615    typedef enum _Elm_Win_Keyboard_Mode
3616      {
3617         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3618         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3619         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3620         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3621         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3622         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3623         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3624         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3625         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3626         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3627         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3628         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3629         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3630         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3631         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3632         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3633      } Elm_Win_Keyboard_Mode;
3634
3635    /**
3636     * Available commands that can be sent to the Illume manager.
3637     *
3638     * When running under an Illume session, a window may send commands to the
3639     * Illume manager to perform different actions.
3640     */
3641    typedef enum _Elm_Illume_Command
3642      {
3643         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3644                                          window */
3645         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3646                                             in the list */
3647         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3648                                          screen */
3649         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3650      } Elm_Illume_Command;
3651
3652    /**
3653     * Adds a window object. If this is the first window created, pass NULL as
3654     * @p parent.
3655     *
3656     * @param parent Parent object to add the window to, or NULL
3657     * @param name The name of the window
3658     * @param type The window type, one of #Elm_Win_Type.
3659     *
3660     * The @p parent paramter can be @c NULL for every window @p type except
3661     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3662     * which the image object will be created.
3663     *
3664     * @return The created object, or NULL on failure
3665     */
3666    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3667    /**
3668     * Add @p subobj as a resize object of window @p obj.
3669     *
3670     *
3671     * Setting an object as a resize object of the window means that the
3672     * @p subobj child's size and position will be controlled by the window
3673     * directly. That is, the object will be resized to match the window size
3674     * and should never be moved or resized manually by the developer.
3675     *
3676     * In addition, resize objects of the window control what the minimum size
3677     * of it will be, as well as whether it can or not be resized by the user.
3678     *
3679     * For the end user to be able to resize a window by dragging the handles
3680     * or borders provided by the Window Manager, or using any other similar
3681     * mechanism, all of the resize objects in the window should have their
3682     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3683     *
3684     * @param obj The window object
3685     * @param subobj The resize object to add
3686     */
3687    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3688    /**
3689     * Delete @p subobj as a resize object of window @p obj.
3690     *
3691     * This function removes the object @p subobj from the resize objects of
3692     * the window @p obj. It will not delete the object itself, which will be
3693     * left unmanaged and should be deleted by the developer, manually handled
3694     * or set as child of some other container.
3695     *
3696     * @param obj The window object
3697     * @param subobj The resize object to add
3698     */
3699    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3700    /**
3701     * Set the title of the window
3702     *
3703     * @param obj The window object
3704     * @param title The title to set
3705     */
3706    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3707    /**
3708     * Get the title of the window
3709     *
3710     * The returned string is an internal one and should not be freed or
3711     * modified. It will also be rendered invalid if a new title is set or if
3712     * the window is destroyed.
3713     *
3714     * @param obj The window object
3715     * @return The title
3716     */
3717    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3718    /**
3719     * Set the window's autodel state.
3720     *
3721     * When closing the window in any way outside of the program control, like
3722     * pressing the X button in the titlebar or using a command from the
3723     * Window Manager, a "delete,request" signal is emitted to indicate that
3724     * this event occurred and the developer can take any action, which may
3725     * include, or not, destroying the window object.
3726     *
3727     * When the @p autodel parameter is set, the window will be automatically
3728     * destroyed when this event occurs, after the signal is emitted.
3729     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3730     * and is up to the program to do so when it's required.
3731     *
3732     * @param obj The window object
3733     * @param autodel If true, the window will automatically delete itself when
3734     * closed
3735     */
3736    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3737    /**
3738     * Get the window's autodel state.
3739     *
3740     * @param obj The window object
3741     * @return If the window will automatically delete itself when closed
3742     *
3743     * @see elm_win_autodel_set()
3744     */
3745    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3746    /**
3747     * Activate a window object.
3748     *
3749     * This function sends a request to the Window Manager to activate the
3750     * window pointed by @p obj. If honored by the WM, the window will receive
3751     * the keyboard focus.
3752     *
3753     * @note This is just a request that a Window Manager may ignore, so calling
3754     * this function does not ensure in any way that the window will be the
3755     * active one after it.
3756     *
3757     * @param obj The window object
3758     */
3759    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3760    /**
3761     * Lower a window object.
3762     *
3763     * Places the window pointed by @p obj at the bottom of the stack, so that
3764     * no other window is covered by it.
3765     *
3766     * If elm_win_override_set() is not set, the Window Manager may ignore this
3767     * request.
3768     *
3769     * @param obj The window object
3770     */
3771    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3772    /**
3773     * Raise a window object.
3774     *
3775     * Places the window pointed by @p obj at the top of the stack, so that it's
3776     * not covered by any other window.
3777     *
3778     * If elm_win_override_set() is not set, the Window Manager may ignore this
3779     * request.
3780     *
3781     * @param obj The window object
3782     */
3783    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3784    /**
3785     * Set the borderless state of a window.
3786     *
3787     * This function requests the Window Manager to not draw any decoration
3788     * around the window.
3789     *
3790     * @param obj The window object
3791     * @param borderless If true, the window is borderless
3792     */
3793    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3794    /**
3795     * Get the borderless state of a window.
3796     *
3797     * @param obj The window object
3798     * @return If true, the window is borderless
3799     */
3800    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3801    /**
3802     * Set the shaped state of a window.
3803     *
3804     * Shaped windows, when supported, will render the parts of the window that
3805     * has no content, transparent.
3806     *
3807     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3808     * background object or cover the entire window in any other way, or the
3809     * parts of the canvas that have no data will show framebuffer artifacts.
3810     *
3811     * @param obj The window object
3812     * @param shaped If true, the window is shaped
3813     *
3814     * @see elm_win_alpha_set()
3815     */
3816    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3817    /**
3818     * Get the shaped state of a window.
3819     *
3820     * @param obj The window object
3821     * @return If true, the window is shaped
3822     *
3823     * @see elm_win_shaped_set()
3824     */
3825    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3826    /**
3827     * Set the alpha channel state of a window.
3828     *
3829     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3830     * possibly making parts of the window completely or partially transparent.
3831     * This is also subject to the underlying system supporting it, like for
3832     * example, running under a compositing manager. If no compositing is
3833     * available, enabling this option will instead fallback to using shaped
3834     * windows, with elm_win_shaped_set().
3835     *
3836     * @param obj The window object
3837     * @param alpha If true, the window has an alpha channel
3838     *
3839     * @see elm_win_alpha_set()
3840     */
3841    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3842    /**
3843     * Get the transparency state of a window.
3844     *
3845     * @param obj The window object
3846     * @return If true, the window is transparent
3847     *
3848     * @see elm_win_transparent_set()
3849     */
3850    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3851    /**
3852     * Set the transparency state of a window.
3853     *
3854     * Use elm_win_alpha_set() instead.
3855     *
3856     * @param obj The window object
3857     * @param transparent If true, the window is transparent
3858     *
3859     * @see elm_win_alpha_set()
3860     */
3861    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3862    /**
3863     * Get the alpha channel state of a window.
3864     *
3865     * @param obj The window object
3866     * @return If true, the window has an alpha channel
3867     */
3868    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3869    /**
3870     * Set the override state of a window.
3871     *
3872     * A window with @p override set to EINA_TRUE will not be managed by the
3873     * Window Manager. This means that no decorations of any kind will be shown
3874     * for it, moving and resizing must be handled by the application, as well
3875     * as the window visibility.
3876     *
3877     * This should not be used for normal windows, and even for not so normal
3878     * ones, it should only be used when there's a good reason and with a lot
3879     * of care. Mishandling override windows may result situations that
3880     * disrupt the normal workflow of the end user.
3881     *
3882     * @param obj The window object
3883     * @param override If true, the window is overridden
3884     */
3885    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3886    /**
3887     * Get the override state of a window.
3888     *
3889     * @param obj The window object
3890     * @return If true, the window is overridden
3891     *
3892     * @see elm_win_override_set()
3893     */
3894    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3895    /**
3896     * Set the fullscreen state of a window.
3897     *
3898     * @param obj The window object
3899     * @param fullscreen If true, the window is fullscreen
3900     */
3901    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3902    /**
3903     * Get the fullscreen state of a window.
3904     *
3905     * @param obj The window object
3906     * @return If true, the window is fullscreen
3907     */
3908    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3909    /**
3910     * Set the maximized state of a window.
3911     *
3912     * @param obj The window object
3913     * @param maximized If true, the window is maximized
3914     */
3915    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3916    /**
3917     * Get the maximized state of a window.
3918     *
3919     * @param obj The window object
3920     * @return If true, the window is maximized
3921     */
3922    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3923    /**
3924     * Set the iconified state of a window.
3925     *
3926     * @param obj The window object
3927     * @param iconified If true, the window is iconified
3928     */
3929    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3930    /**
3931     * Get the iconified state of a window.
3932     *
3933     * @param obj The window object
3934     * @return If true, the window is iconified
3935     */
3936    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3937    /**
3938     * Set the layer of the window.
3939     *
3940     * What this means exactly will depend on the underlying engine used.
3941     *
3942     * In the case of X11 backed engines, the value in @p layer has the
3943     * following meanings:
3944     * @li < 3: The window will be placed below all others.
3945     * @li > 5: The window will be placed above all others.
3946     * @li other: The window will be placed in the default layer.
3947     *
3948     * @param obj The window object
3949     * @param layer The layer of the window
3950     */
3951    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3952    /**
3953     * Get the layer of the window.
3954     *
3955     * @param obj The window object
3956     * @return The layer of the window
3957     *
3958     * @see elm_win_layer_set()
3959     */
3960    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961    /**
3962     * Set the rotation of the window.
3963     *
3964     * Most engines only work with multiples of 90.
3965     *
3966     * This function is used to set the orientation of the window @p obj to
3967     * match that of the screen. The window itself will be resized to adjust
3968     * to the new geometry of its contents. If you want to keep the window size,
3969     * see elm_win_rotation_with_resize_set().
3970     *
3971     * @param obj The window object
3972     * @param rotation The rotation of the window, in degrees (0-360),
3973     * counter-clockwise.
3974     */
3975    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3976    /**
3977     * Rotates the window and resizes it.
3978     *
3979     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3980     * that they fit inside the current window geometry.
3981     *
3982     * @param obj The window object
3983     * @param layer The rotation of the window in degrees (0-360),
3984     * counter-clockwise.
3985     */
3986    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3987    /**
3988     * Get the rotation of the window.
3989     *
3990     * @param obj The window object
3991     * @return The rotation of the window in degrees (0-360)
3992     *
3993     * @see elm_win_rotation_set()
3994     * @see elm_win_rotation_with_resize_set()
3995     */
3996    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3997    /**
3998     * Set the sticky state of the window.
3999     *
4000     * Hints the Window Manager that the window in @p obj should be left fixed
4001     * at its position even when the virtual desktop it's on moves or changes.
4002     *
4003     * @param obj The window object
4004     * @param sticky If true, the window's sticky state is enabled
4005     */
4006    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4007    /**
4008     * Get the sticky state of the window.
4009     *
4010     * @param obj The window object
4011     * @return If true, the window's sticky state is enabled
4012     *
4013     * @see elm_win_sticky_set()
4014     */
4015    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4016    /**
4017     * Set if this window is an illume conformant window
4018     *
4019     * @param obj The window object
4020     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4021     */
4022    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4023    /**
4024     * Get if this window is an illume conformant window
4025     *
4026     * @param obj The window object
4027     * @return A boolean if this window is illume conformant or not
4028     */
4029    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4030    /**
4031     * Set a window to be an illume quickpanel window
4032     *
4033     * By default window objects are not quickpanel windows.
4034     *
4035     * @param obj The window object
4036     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4037     */
4038    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4039    /**
4040     * Get if this window is a quickpanel or not
4041     *
4042     * @param obj The window object
4043     * @return A boolean if this window is a quickpanel or not
4044     */
4045    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4046    /**
4047     * Set the major priority of a quickpanel window
4048     *
4049     * @param obj The window object
4050     * @param priority The major priority for this quickpanel
4051     */
4052    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4053    /**
4054     * Get the major priority of a quickpanel window
4055     *
4056     * @param obj The window object
4057     * @return The major priority of this quickpanel
4058     */
4059    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4060    /**
4061     * Set the minor priority of a quickpanel window
4062     *
4063     * @param obj The window object
4064     * @param priority The minor priority for this quickpanel
4065     */
4066    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4067    /**
4068     * Get the minor priority of a quickpanel window
4069     *
4070     * @param obj The window object
4071     * @return The minor priority of this quickpanel
4072     */
4073    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4074    /**
4075     * Set which zone this quickpanel should appear in
4076     *
4077     * @param obj The window object
4078     * @param zone The requested zone for this quickpanel
4079     */
4080    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4081    /**
4082     * Get which zone this quickpanel should appear in
4083     *
4084     * @param obj The window object
4085     * @return The requested zone for this quickpanel
4086     */
4087    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4088    /**
4089     * Set the window to be skipped by keyboard focus
4090     *
4091     * This sets the window to be skipped by normal keyboard input. This means
4092     * a window manager will be asked to not focus this window as well as omit
4093     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4094     *
4095     * Call this and enable it on a window BEFORE you show it for the first time,
4096     * otherwise it may have no effect.
4097     *
4098     * Use this for windows that have only output information or might only be
4099     * interacted with by the mouse or fingers, and never for typing input.
4100     * Be careful that this may have side-effects like making the window
4101     * non-accessible in some cases unless the window is specially handled. Use
4102     * this with care.
4103     *
4104     * @param obj The window object
4105     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4106     */
4107    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4108    /**
4109     * Send a command to the windowing environment
4110     *
4111     * This is intended to work in touchscreen or small screen device
4112     * environments where there is a more simplistic window management policy in
4113     * place. This uses the window object indicated to select which part of the
4114     * environment to control (the part that this window lives in), and provides
4115     * a command and an optional parameter structure (use NULL for this if not
4116     * needed).
4117     *
4118     * @param obj The window object that lives in the environment to control
4119     * @param command The command to send
4120     * @param params Optional parameters for the command
4121     */
4122    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4123    /**
4124     * Get the inlined image object handle
4125     *
4126     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4127     * then the window is in fact an evas image object inlined in the parent
4128     * canvas. You can get this object (be careful to not manipulate it as it
4129     * is under control of elementary), and use it to do things like get pixel
4130     * data, save the image to a file, etc.
4131     *
4132     * @param obj The window object to get the inlined image from
4133     * @return The inlined image object, or NULL if none exists
4134     */
4135    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4136    /**
4137     * Set the enabled status for the focus highlight in a window
4138     *
4139     * This function will enable or disable the focus highlight only for the
4140     * given window, regardless of the global setting for it
4141     *
4142     * @param obj The window where to enable the highlight
4143     * @param enabled The enabled value for the highlight
4144     */
4145    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4146    /**
4147     * Get the enabled value of the focus highlight for this window
4148     *
4149     * @param obj The window in which to check if the focus highlight is enabled
4150     *
4151     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4152     */
4153    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4154    /**
4155     * Set the style for the focus highlight on this window
4156     *
4157     * Sets the style to use for theming the highlight of focused objects on
4158     * the given window. If @p style is NULL, the default will be used.
4159     *
4160     * @param obj The window where to set the style
4161     * @param style The style to set
4162     */
4163    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4164    /**
4165     * Get the style set for the focus highlight object
4166     *
4167     * Gets the style set for this windows highilght object, or NULL if none
4168     * is set.
4169     *
4170     * @param obj The window to retrieve the highlights style from
4171     *
4172     * @return The style set or NULL if none was. Default is used in that case.
4173     */
4174    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4175    EAPI void         elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4176    EAPI int          elm_win_indicator_state_get(Evas_Object *obj);
4177    /*...
4178     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4179     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4180     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4181     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4182     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4183     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4184     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4185     *
4186     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4187     * (blank mouse, private mouse obj, defaultmouse)
4188     *
4189     */
4190    /**
4191     * Sets the keyboard mode of the window.
4192     *
4193     * @param obj The window object
4194     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4195     */
4196    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4197    /**
4198     * Gets the keyboard mode of the window.
4199     *
4200     * @param obj The window object
4201     * @return The mode, one of #Elm_Win_Keyboard_Mode
4202     */
4203    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4204    /**
4205     * Sets whether the window is a keyboard.
4206     *
4207     * @param obj The window object
4208     * @param is_keyboard If true, the window is a virtual keyboard
4209     */
4210    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4211    /**
4212     * Gets whether the window is a keyboard.
4213     *
4214     * @param obj The window object
4215     * @return If the window is a virtual keyboard
4216     */
4217    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4218
4219    /**
4220     * Get the screen position of a window.
4221     *
4222     * @param obj The window object
4223     * @param x The int to store the x coordinate to
4224     * @param y The int to store the y coordinate to
4225     */
4226    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4227    /**
4228     * @}
4229     */
4230
4231    /**
4232     * @defgroup Inwin Inwin
4233     *
4234     * @image html img/widget/inwin/preview-00.png
4235     * @image latex img/widget/inwin/preview-00.eps
4236     * @image html img/widget/inwin/preview-01.png
4237     * @image latex img/widget/inwin/preview-01.eps
4238     * @image html img/widget/inwin/preview-02.png
4239     * @image latex img/widget/inwin/preview-02.eps
4240     *
4241     * An inwin is a window inside a window that is useful for a quick popup.
4242     * It does not hover.
4243     *
4244     * It works by creating an object that will occupy the entire window, so it
4245     * must be created using an @ref Win "elm_win" as parent only. The inwin
4246     * object can be hidden or restacked below every other object if it's
4247     * needed to show what's behind it without destroying it. If this is done,
4248     * the elm_win_inwin_activate() function can be used to bring it back to
4249     * full visibility again.
4250     *
4251     * There are three styles available in the default theme. These are:
4252     * @li default: The inwin is sized to take over most of the window it's
4253     * placed in.
4254     * @li minimal: The size of the inwin will be the minimum necessary to show
4255     * its contents.
4256     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4257     * possible, but it's sized vertically the most it needs to fit its\
4258     * contents.
4259     *
4260     * Some examples of Inwin can be found in the following:
4261     * @li @ref inwin_example_01
4262     *
4263     * @{
4264     */
4265    /**
4266     * Adds an inwin to the current window
4267     *
4268     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4269     * Never call this function with anything other than the top-most window
4270     * as its parameter, unless you are fond of undefined behavior.
4271     *
4272     * After creating the object, the widget will set itself as resize object
4273     * for the window with elm_win_resize_object_add(), so when shown it will
4274     * appear to cover almost the entire window (how much of it depends on its
4275     * content and the style used). It must not be added into other container
4276     * objects and it needs not be moved or resized manually.
4277     *
4278     * @param parent The parent object
4279     * @return The new object or NULL if it cannot be created
4280     */
4281    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4282    /**
4283     * Activates an inwin object, ensuring its visibility
4284     *
4285     * This function will make sure that the inwin @p obj is completely visible
4286     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4287     * to the front. It also sets the keyboard focus to it, which will be passed
4288     * onto its content.
4289     *
4290     * The object's theme will also receive the signal "elm,action,show" with
4291     * source "elm".
4292     *
4293     * @param obj The inwin to activate
4294     */
4295    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4296    /**
4297     * Set the content of an inwin object.
4298     *
4299     * Once the content object is set, a previously set one will be deleted.
4300     * If you want to keep that old content object, use the
4301     * elm_win_inwin_content_unset() function.
4302     *
4303     * @param obj The inwin object
4304     * @param content The object to set as content
4305     */
4306    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4307    /**
4308     * Get the content of an inwin object.
4309     *
4310     * Return the content object which is set for this widget.
4311     *
4312     * The returned object is valid as long as the inwin is still alive and no
4313     * other content is set on it. Deleting the object will notify the inwin
4314     * about it and this one will be left empty.
4315     *
4316     * If you need to remove an inwin's content to be reused somewhere else,
4317     * see elm_win_inwin_content_unset().
4318     *
4319     * @param obj The inwin object
4320     * @return The content that is being used
4321     */
4322    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4323    /**
4324     * Unset the content of an inwin object.
4325     *
4326     * Unparent and return the content object which was set for this widget.
4327     *
4328     * @param obj The inwin object
4329     * @return The content that was being used
4330     */
4331    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4332    /**
4333     * @}
4334     */
4335    /* X specific calls - won't work on non-x engines (return 0) */
4336
4337    /**
4338     * Get the Ecore_X_Window of an Evas_Object
4339     *
4340     * @param obj The object
4341     *
4342     * @return The Ecore_X_Window of @p obj
4343     *
4344     * @ingroup Win
4345     */
4346    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4347
4348    /* smart callbacks called:
4349     * "delete,request" - the user requested to delete the window
4350     * "focus,in" - window got focus
4351     * "focus,out" - window lost focus
4352     * "moved" - window that holds the canvas was moved
4353     */
4354
4355    /**
4356     * @defgroup Bg Bg
4357     *
4358     * @image html img/widget/bg/preview-00.png
4359     * @image latex img/widget/bg/preview-00.eps
4360     *
4361     * @brief Background object, used for setting a solid color, image or Edje
4362     * group as background to a window or any container object.
4363     *
4364     * The bg object is used for setting a solid background to a window or
4365     * packing into any container object. It works just like an image, but has
4366     * some properties useful to a background, like setting it to tiled,
4367     * centered, scaled or stretched.
4368     * 
4369     * Default contents parts of the bg widget that you can use for are:
4370     * @li "elm.swallow.content" - overlay of the bg
4371     *
4372     * Here is some sample code using it:
4373     * @li @ref bg_01_example_page
4374     * @li @ref bg_02_example_page
4375     * @li @ref bg_03_example_page
4376     */
4377
4378    /* bg */
4379    typedef enum _Elm_Bg_Option
4380      {
4381         ELM_BG_OPTION_CENTER,  /**< center the background */
4382         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4383         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4384         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4385      } Elm_Bg_Option;
4386
4387    /**
4388     * Add a new background to the parent
4389     *
4390     * @param parent The parent object
4391     * @return The new object or NULL if it cannot be created
4392     *
4393     * @ingroup Bg
4394     */
4395    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4396
4397    /**
4398     * Set the file (image or edje) used for the background
4399     *
4400     * @param obj The bg object
4401     * @param file The file path
4402     * @param group Optional key (group in Edje) within the file
4403     *
4404     * This sets the image file used in the background object. The image (or edje)
4405     * will be stretched (retaining aspect if its an image file) to completely fill
4406     * the bg object. This may mean some parts are not visible.
4407     *
4408     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4409     * even if @p file is NULL.
4410     *
4411     * @ingroup Bg
4412     */
4413    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4414
4415    /**
4416     * Get the file (image or edje) used for the background
4417     *
4418     * @param obj The bg object
4419     * @param file The file path
4420     * @param group Optional key (group in Edje) within the file
4421     *
4422     * @ingroup Bg
4423     */
4424    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4425
4426    /**
4427     * Set the option used for the background image
4428     *
4429     * @param obj The bg object
4430     * @param option The desired background option (TILE, SCALE)
4431     *
4432     * This sets the option used for manipulating the display of the background
4433     * image. The image can be tiled or scaled.
4434     *
4435     * @ingroup Bg
4436     */
4437    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4438
4439    /**
4440     * Get the option used for the background image
4441     *
4442     * @param obj The bg object
4443     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4444     *
4445     * @ingroup Bg
4446     */
4447    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4448    /**
4449     * Set the option used for the background color
4450     *
4451     * @param obj The bg object
4452     * @param r
4453     * @param g
4454     * @param b
4455     *
4456     * This sets the color used for the background rectangle. Its range goes
4457     * from 0 to 255.
4458     *
4459     * @ingroup Bg
4460     */
4461    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4462    /**
4463     * Get the option used for the background color
4464     *
4465     * @param obj The bg object
4466     * @param r
4467     * @param g
4468     * @param b
4469     *
4470     * @ingroup Bg
4471     */
4472    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4473
4474    /**
4475     * Set the overlay object used for the background object.
4476     *
4477     * @param obj The bg object
4478     * @param overlay The overlay object
4479     *
4480     * This provides a way for elm_bg to have an 'overlay' that will be on top
4481     * of the bg. Once the over object is set, a previously set one will be
4482     * deleted, even if you set the new one to NULL. If you want to keep that
4483     * old content object, use the elm_bg_overlay_unset() function.
4484     *
4485     * @ingroup Bg
4486     */
4487
4488    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4489
4490    /**
4491     * Get the overlay object used for the background object.
4492     *
4493     * @param obj The bg object
4494     * @return The content that is being used
4495     *
4496     * Return the content object which is set for this widget
4497     *
4498     * @ingroup Bg
4499     */
4500    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4501
4502    /**
4503     * Get the overlay object used for the background object.
4504     *
4505     * @param obj The bg object
4506     * @return The content that was being used
4507     *
4508     * Unparent and return the overlay object which was set for this widget
4509     *
4510     * @ingroup Bg
4511     */
4512    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4513
4514    /**
4515     * Set the size of the pixmap representation of the image.
4516     *
4517     * This option just makes sense if an image is going to be set in the bg.
4518     *
4519     * @param obj The bg object
4520     * @param w The new width of the image pixmap representation.
4521     * @param h The new height of the image pixmap representation.
4522     *
4523     * This function sets a new size for pixmap representation of the given bg
4524     * image. It allows the image to be loaded already in the specified size,
4525     * reducing the memory usage and load time when loading a big image with load
4526     * size set to a smaller size.
4527     *
4528     * NOTE: this is just a hint, the real size of the pixmap may differ
4529     * depending on the type of image being loaded, being bigger than requested.
4530     *
4531     * @ingroup Bg
4532     */
4533    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4534    /* smart callbacks called:
4535     */
4536
4537    /**
4538     * @defgroup Icon Icon
4539     *
4540     * @image html img/widget/icon/preview-00.png
4541     * @image latex img/widget/icon/preview-00.eps
4542     *
4543     * An object that provides standard icon images (delete, edit, arrows, etc.)
4544     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4545     *
4546     * The icon image requested can be in the elementary theme, or in the
4547     * freedesktop.org paths. It's possible to set the order of preference from
4548     * where the image will be used.
4549     *
4550     * This API is very similar to @ref Image, but with ready to use images.
4551     *
4552     * Default images provided by the theme are described below.
4553     *
4554     * The first list contains icons that were first intended to be used in
4555     * toolbars, but can be used in many other places too:
4556     * @li home
4557     * @li close
4558     * @li apps
4559     * @li arrow_up
4560     * @li arrow_down
4561     * @li arrow_left
4562     * @li arrow_right
4563     * @li chat
4564     * @li clock
4565     * @li delete
4566     * @li edit
4567     * @li refresh
4568     * @li folder
4569     * @li file
4570     *
4571     * Now some icons that were designed to be used in menus (but again, you can
4572     * use them anywhere else):
4573     * @li menu/home
4574     * @li menu/close
4575     * @li menu/apps
4576     * @li menu/arrow_up
4577     * @li menu/arrow_down
4578     * @li menu/arrow_left
4579     * @li menu/arrow_right
4580     * @li menu/chat
4581     * @li menu/clock
4582     * @li menu/delete
4583     * @li menu/edit
4584     * @li menu/refresh
4585     * @li menu/folder
4586     * @li menu/file
4587     *
4588     * And here we have some media player specific icons:
4589     * @li media_player/forward
4590     * @li media_player/info
4591     * @li media_player/next
4592     * @li media_player/pause
4593     * @li media_player/play
4594     * @li media_player/prev
4595     * @li media_player/rewind
4596     * @li media_player/stop
4597     *
4598     * Signals that you can add callbacks for are:
4599     *
4600     * "clicked" - This is called when a user has clicked the icon
4601     *
4602     * An example of usage for this API follows:
4603     * @li @ref tutorial_icon
4604     */
4605
4606    /**
4607     * @addtogroup Icon
4608     * @{
4609     */
4610
4611    typedef enum _Elm_Icon_Type
4612      {
4613         ELM_ICON_NONE,
4614         ELM_ICON_FILE,
4615         ELM_ICON_STANDARD
4616      } Elm_Icon_Type;
4617    /**
4618     * @enum _Elm_Icon_Lookup_Order
4619     * @typedef Elm_Icon_Lookup_Order
4620     *
4621     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4622     * theme, FDO paths, or both?
4623     *
4624     * @ingroup Icon
4625     */
4626    typedef enum _Elm_Icon_Lookup_Order
4627      {
4628         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4629         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4630         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4631         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4632      } Elm_Icon_Lookup_Order;
4633
4634    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4635    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4636    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4637    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4638    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4639    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4640    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4641    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4642    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4643    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4644    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4645    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4646    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4647    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4648    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4649    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4650    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4651    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4652    EAPI Eina_Bool             elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4653    EAPI void                  elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
4654    EAPI Eina_Bool             elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4655    EAPI void                  elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4656    EAPI Eina_Bool             elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4657
4658    /* smart callbacks called:
4659     * "clicked" - the user clicked the icon
4660     */
4661
4662    /* image */
4663    typedef enum _Elm_Image_Orient
4664      {
4665         ELM_IMAGE_ORIENT_NONE,
4666         ELM_IMAGE_ROTATE_90_CW,
4667         ELM_IMAGE_ROTATE_180_CW,
4668         ELM_IMAGE_ROTATE_90_CCW,
4669         ELM_IMAGE_FLIP_HORIZONTAL,
4670         ELM_IMAGE_FLIP_VERTICAL,
4671         ELM_IMAGE_FLIP_TRANSPOSE,
4672         ELM_IMAGE_FLIP_TRANSVERSE
4673      } Elm_Image_Orient;
4674    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4675    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4676    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4677    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4678    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4679    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4680    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4681    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4682    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4683    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4684    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4685    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4686    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4687    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4688    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
4689    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4690    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
4691    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4692    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4693    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
4694    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4695
4696    /* smart callbacks called:
4697     * "clicked" - the user clicked the image
4698     */
4699
4700    /* glview */
4701    typedef void (*Elm_GLView_Func)(Evas_Object *obj);
4702
4703    typedef enum _Elm_GLView_Mode
4704      {
4705         ELM_GLVIEW_ALPHA   = 1,
4706         ELM_GLVIEW_DEPTH   = 2,
4707         ELM_GLVIEW_STENCIL = 4
4708      } Elm_GLView_Mode;
4709
4710    /**
4711     * Defines a policy for the glview resizing.
4712     *
4713     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
4714     */
4715    typedef enum _Elm_GLView_Resize_Policy
4716      {
4717         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
4718         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
4719      } Elm_GLView_Resize_Policy;
4720
4721    typedef enum _Elm_GLView_Render_Policy
4722      {
4723         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
4724         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
4725      } Elm_GLView_Render_Policy;
4726
4727
4728    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4729    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4730    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4731    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4732    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
4733    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
4734    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
4735    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
4736    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
4737    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
4738    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
4739    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4740
4741    /* box */
4742    /**
4743     * @defgroup Box Box
4744     *
4745     * A box arranges objects in a linear fashion, governed by a layout function
4746     * that defines the details of this arrangement.
4747     *
4748     * By default, the box will use an internal function to set the layout to
4749     * a single row, either vertical or horizontal. This layout is affected
4750     * by a number of parameters, such as the homogeneous flag set by
4751     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
4752     * elm_box_align_set() and the hints set to each object in the box.
4753     *
4754     * For this default layout, it's possible to change the orientation with
4755     * elm_box_horizontal_set(). The box will start in the vertical orientation,
4756     * placing its elements ordered from top to bottom. When horizontal is set,
4757     * the order will go from left to right. If the box is set to be
4758     * homogeneous, every object in it will be assigned the same space, that
4759     * of the largest object. Padding can be used to set some spacing between
4760     * the cell given to each object. The alignment of the box, set with
4761     * elm_box_align_set(), determines how the bounding box of all the elements
4762     * will be placed within the space given to the box widget itself.
4763     *
4764     * The size hints of each object also affect how they are placed and sized
4765     * within the box. evas_object_size_hint_min_set() will give the minimum
4766     * size the object can have, and the box will use it as the basis for all
4767     * latter calculations. Elementary widgets set their own minimum size as
4768     * needed, so there's rarely any need to use it manually.
4769     *
4770     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
4771     * used to tell whether the object will be allocated the minimum size it
4772     * needs or if the space given to it should be expanded. It's important
4773     * to realize that expanding the size given to the object is not the same
4774     * thing as resizing the object. It could very well end being a small
4775     * widget floating in a much larger empty space. If not set, the weight
4776     * for objects will normally be 0.0 for both axis, meaning the widget will
4777     * not be expanded. To take as much space possible, set the weight to
4778     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
4779     *
4780     * Besides how much space each object is allocated, it's possible to control
4781     * how the widget will be placed within that space using
4782     * evas_object_size_hint_align_set(). By default, this value will be 0.5
4783     * for both axis, meaning the object will be centered, but any value from
4784     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
4785     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
4786     * is -1.0, means the object will be resized to fill the entire space it
4787     * was allocated.
4788     *
4789     * In addition, customized functions to define the layout can be set, which
4790     * allow the application developer to organize the objects within the box
4791     * in any number of ways.
4792     *
4793     * The special elm_box_layout_transition() function can be used
4794     * to switch from one layout to another, animating the motion of the
4795     * children of the box.
4796     *
4797     * @note Objects should not be added to box objects using _add() calls.
4798     *
4799     * Some examples on how to use boxes follow:
4800     * @li @ref box_example_01
4801     * @li @ref box_example_02
4802     *
4803     * @{
4804     */
4805    /**
4806     * @typedef Elm_Box_Transition
4807     *
4808     * Opaque handler containing the parameters to perform an animated
4809     * transition of the layout the box uses.
4810     *
4811     * @see elm_box_transition_new()
4812     * @see elm_box_layout_set()
4813     * @see elm_box_layout_transition()
4814     */
4815    typedef struct _Elm_Box_Transition Elm_Box_Transition;
4816
4817    /**
4818     * Add a new box to the parent
4819     *
4820     * By default, the box will be in vertical mode and non-homogeneous.
4821     *
4822     * @param parent The parent object
4823     * @return The new object or NULL if it cannot be created
4824     */
4825    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4826    /**
4827     * Set the horizontal orientation
4828     *
4829     * By default, box object arranges their contents vertically from top to
4830     * bottom.
4831     * By calling this function with @p horizontal as EINA_TRUE, the box will
4832     * become horizontal, arranging contents from left to right.
4833     *
4834     * @note This flag is ignored if a custom layout function is set.
4835     *
4836     * @param obj The box object
4837     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
4838     * EINA_FALSE = vertical)
4839     */
4840    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
4841    /**
4842     * Get the horizontal orientation
4843     *
4844     * @param obj The box object
4845     * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
4846     */
4847    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4848    /**
4849     * Set the box to arrange its children homogeneously
4850     *
4851     * If enabled, homogeneous layout makes all items the same size, according
4852     * to the size of the largest of its children.
4853     *
4854     * @note This flag is ignored if a custom layout function is set.
4855     *
4856     * @param obj The box object
4857     * @param homogeneous The homogeneous flag
4858     */
4859    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
4860    /**
4861     * Get whether the box is using homogeneous mode or not
4862     *
4863     * @param obj The box object
4864     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
4865     */
4866    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4867    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
4868    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4869    /**
4870     * Add an object to the beginning of the pack list
4871     *
4872     * Pack @p subobj into the box @p obj, placing it first in the list of
4873     * children objects. The actual position the object will get on screen
4874     * depends on the layout used. If no custom layout is set, it will be at
4875     * the top or left, depending if the box is vertical or horizontal,
4876     * respectively.
4877     *
4878     * @param obj The box object
4879     * @param subobj The object to add to the box
4880     *
4881     * @see elm_box_pack_end()
4882     * @see elm_box_pack_before()
4883     * @see elm_box_pack_after()
4884     * @see elm_box_unpack()
4885     * @see elm_box_unpack_all()
4886     * @see elm_box_clear()
4887     */
4888    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4889    /**
4890     * Add an object at the end of the pack list
4891     *
4892     * Pack @p subobj into the box @p obj, placing it last in the list of
4893     * children objects. The actual position the object will get on screen
4894     * depends on the layout used. If no custom layout is set, it will be at
4895     * the bottom or right, depending if the box is vertical or horizontal,
4896     * respectively.
4897     *
4898     * @param obj The box object
4899     * @param subobj The object to add to the box
4900     *
4901     * @see elm_box_pack_start()
4902     * @see elm_box_pack_before()
4903     * @see elm_box_pack_after()
4904     * @see elm_box_unpack()
4905     * @see elm_box_unpack_all()
4906     * @see elm_box_clear()
4907     */
4908    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4909    /**
4910     * Adds an object to the box before the indicated object
4911     *
4912     * This will add the @p subobj to the box indicated before the object
4913     * indicated with @p before. If @p before is not already in the box, results
4914     * are undefined. Before means either to the left of the indicated object or
4915     * above it depending on orientation.
4916     *
4917     * @param obj The box object
4918     * @param subobj The object to add to the box
4919     * @param before The object before which to add it
4920     *
4921     * @see elm_box_pack_start()
4922     * @see elm_box_pack_end()
4923     * @see elm_box_pack_after()
4924     * @see elm_box_unpack()
4925     * @see elm_box_unpack_all()
4926     * @see elm_box_clear()
4927     */
4928    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
4929    /**
4930     * Adds an object to the box after the indicated object
4931     *
4932     * This will add the @p subobj to the box indicated after the object
4933     * indicated with @p after. If @p after is not already in the box, results
4934     * are undefined. After means either to the right of the indicated object or
4935     * below it depending on orientation.
4936     *
4937     * @param obj The box object
4938     * @param subobj The object to add to the box
4939     * @param after The object after which to add it
4940     *
4941     * @see elm_box_pack_start()
4942     * @see elm_box_pack_end()
4943     * @see elm_box_pack_before()
4944     * @see elm_box_unpack()
4945     * @see elm_box_unpack_all()
4946     * @see elm_box_clear()
4947     */
4948    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
4949    /**
4950     * Clear the box of all children
4951     *
4952     * Remove all the elements contained by the box, deleting the respective
4953     * objects.
4954     *
4955     * @param obj The box object
4956     *
4957     * @see elm_box_unpack()
4958     * @see elm_box_unpack_all()
4959     */
4960    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4961    /**
4962     * Unpack a box item
4963     *
4964     * Remove the object given by @p subobj from the box @p obj without
4965     * deleting it.
4966     *
4967     * @param obj The box object
4968     *
4969     * @see elm_box_unpack_all()
4970     * @see elm_box_clear()
4971     */
4972    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4973    /**
4974     * Remove all items from the box, without deleting them
4975     *
4976     * Clear the box from all children, but don't delete the respective objects.
4977     * If no other references of the box children exist, the objects will never
4978     * be deleted, and thus the application will leak the memory. Make sure
4979     * when using this function that you hold a reference to all the objects
4980     * in the box @p obj.
4981     *
4982     * @param obj The box object
4983     *
4984     * @see elm_box_clear()
4985     * @see elm_box_unpack()
4986     */
4987    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4988    /**
4989     * Retrieve a list of the objects packed into the box
4990     *
4991     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
4992     * The order of the list corresponds to the packing order the box uses.
4993     *
4994     * You must free this list with eina_list_free() once you are done with it.
4995     *
4996     * @param obj The box object
4997     */
4998    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4999    /**
5000     * Set the space (padding) between the box's elements.
5001     *
5002     * Extra space in pixels that will be added between a box child and its
5003     * neighbors after its containing cell has been calculated. This padding
5004     * is set for all elements in the box, besides any possible padding that
5005     * individual elements may have through their size hints.
5006     *
5007     * @param obj The box object
5008     * @param horizontal The horizontal space between elements
5009     * @param vertical The vertical space between elements
5010     */
5011    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5012    /**
5013     * Get the space (padding) between the box's elements.
5014     *
5015     * @param obj The box object
5016     * @param horizontal The horizontal space between elements
5017     * @param vertical The vertical space between elements
5018     *
5019     * @see elm_box_padding_set()
5020     */
5021    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5022    /**
5023     * Set the alignment of the whole bouding box of contents.
5024     *
5025     * Sets how the bounding box containing all the elements of the box, after
5026     * their sizes and position has been calculated, will be aligned within
5027     * the space given for the whole box widget.
5028     *
5029     * @param obj The box object
5030     * @param horizontal The horizontal alignment of elements
5031     * @param vertical The vertical alignment of elements
5032     */
5033    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5034    /**
5035     * Get the alignment of the whole bouding box of contents.
5036     *
5037     * @param obj The box object
5038     * @param horizontal The horizontal alignment of elements
5039     * @param vertical The vertical alignment of elements
5040     *
5041     * @see elm_box_align_set()
5042     */
5043    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5044
5045    /**
5046     * Set the layout defining function to be used by the box
5047     *
5048     * Whenever anything changes that requires the box in @p obj to recalculate
5049     * the size and position of its elements, the function @p cb will be called
5050     * to determine what the layout of the children will be.
5051     *
5052     * Once a custom function is set, everything about the children layout
5053     * is defined by it. The flags set by elm_box_horizontal_set() and
5054     * elm_box_homogeneous_set() no longer have any meaning, and the values
5055     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5056     * layout function to decide if they are used and how. These last two
5057     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5058     * passed to @p cb. The @c Evas_Object the function receives is not the
5059     * Elementary widget, but the internal Evas Box it uses, so none of the
5060     * functions described here can be used on it.
5061     *
5062     * Any of the layout functions in @c Evas can be used here, as well as the
5063     * special elm_box_layout_transition().
5064     *
5065     * The final @p data argument received by @p cb is the same @p data passed
5066     * here, and the @p free_data function will be called to free it
5067     * whenever the box is destroyed or another layout function is set.
5068     *
5069     * Setting @p cb to NULL will revert back to the default layout function.
5070     *
5071     * @param obj The box object
5072     * @param cb The callback function used for layout
5073     * @param data Data that will be passed to layout function
5074     * @param free_data Function called to free @p data
5075     *
5076     * @see elm_box_layout_transition()
5077     */
5078    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);
5079    /**
5080     * Special layout function that animates the transition from one layout to another
5081     *
5082     * Normally, when switching the layout function for a box, this will be
5083     * reflected immediately on screen on the next render, but it's also
5084     * possible to do this through an animated transition.
5085     *
5086     * This is done by creating an ::Elm_Box_Transition and setting the box
5087     * layout to this function.
5088     *
5089     * For example:
5090     * @code
5091     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5092     *                            evas_object_box_layout_vertical, // start
5093     *                            NULL, // data for initial layout
5094     *                            NULL, // free function for initial data
5095     *                            evas_object_box_layout_horizontal, // end
5096     *                            NULL, // data for final layout
5097     *                            NULL, // free function for final data
5098     *                            anim_end, // will be called when animation ends
5099     *                            NULL); // data for anim_end function\
5100     * elm_box_layout_set(box, elm_box_layout_transition, t,
5101     *                    elm_box_transition_free);
5102     * @endcode
5103     *
5104     * @note This function can only be used with elm_box_layout_set(). Calling
5105     * it directly will not have the expected results.
5106     *
5107     * @see elm_box_transition_new
5108     * @see elm_box_transition_free
5109     * @see elm_box_layout_set
5110     */
5111    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5112    /**
5113     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5114     *
5115     * If you want to animate the change from one layout to another, you need
5116     * to set the layout function of the box to elm_box_layout_transition(),
5117     * passing as user data to it an instance of ::Elm_Box_Transition with the
5118     * necessary information to perform this animation. The free function to
5119     * set for the layout is elm_box_transition_free().
5120     *
5121     * The parameters to create an ::Elm_Box_Transition sum up to how long
5122     * will it be, in seconds, a layout function to describe the initial point,
5123     * another for the final position of the children and one function to be
5124     * called when the whole animation ends. This last function is useful to
5125     * set the definitive layout for the box, usually the same as the end
5126     * layout for the animation, but could be used to start another transition.
5127     *
5128     * @param start_layout The layout function that will be used to start the animation
5129     * @param start_layout_data The data to be passed the @p start_layout function
5130     * @param start_layout_free_data Function to free @p start_layout_data
5131     * @param end_layout The layout function that will be used to end the animation
5132     * @param end_layout_free_data The data to be passed the @p end_layout function
5133     * @param end_layout_free_data Function to free @p end_layout_data
5134     * @param transition_end_cb Callback function called when animation ends
5135     * @param transition_end_data Data to be passed to @p transition_end_cb
5136     * @return An instance of ::Elm_Box_Transition
5137     *
5138     * @see elm_box_transition_new
5139     * @see elm_box_layout_transition
5140     */
5141    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);
5142    /**
5143     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5144     *
5145     * This function is mostly useful as the @c free_data parameter in
5146     * elm_box_layout_set() when elm_box_layout_transition().
5147     *
5148     * @param data The Elm_Box_Transition instance to be freed.
5149     *
5150     * @see elm_box_transition_new
5151     * @see elm_box_layout_transition
5152     */
5153    EAPI void                elm_box_transition_free(void *data);
5154    /**
5155     * @}
5156     */
5157
5158    /* button */
5159    /**
5160     * @defgroup Button Button
5161     *
5162     * @image html  widget/button/preview-00.png
5163     * @image html  widget/button/preview-01.png
5164     * @image html  widget/button/preview-02.png
5165     *
5166     * This is a push-button. Press it and run some function. It can contain
5167     * a simple label and icon object and it also has an autorepeat feature.
5168     *
5169     * This widgets emits the following signals:
5170     * @li "clicked": the user clicked the button (press/release).
5171     * @li "repeated": the user pressed the button without releasing it.
5172     * @li "pressed": button was pressed.
5173     * @li "unpressed": button was released after being pressed.
5174     * In all three cases, the @c event parameter of the callback will be
5175     * @c NULL.
5176     *
5177     * Also, defined in the default theme, the button has the following styles
5178     * available:
5179     * @li default: a normal button.
5180     * @li anchor: Like default, but the button fades away when the mouse is not
5181     * over it, leaving only the text or icon.
5182     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5183     * continuous look across its options.
5184     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5185     *
5186     * Follow through a complete example @ref button_example_01 "here".
5187     * @{
5188     */
5189
5190    typedef enum
5191      {
5192         UIControlStateDefault,
5193         UIControlStateHighlighted,
5194         UIControlStateDisabled,
5195         UIControlStateFocused,
5196         UIControlStateReserved
5197      } UIControlState;
5198
5199    /**
5200     * Add a new button to the parent's canvas
5201     *
5202     * @param parent The parent object
5203     * @return The new object or NULL if it cannot be created
5204     */
5205    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5206    /**
5207     * Set the label used in the button
5208     *
5209     * The passed @p label can be NULL to clean any existing text in it and
5210     * leave the button as an icon only object.
5211     *
5212     * @param obj The button object
5213     * @param label The text will be written on the button
5214     * @deprecated use elm_object_text_set() instead.
5215     */
5216    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5217    /**
5218     * Get the label set for the button
5219     *
5220     * The string returned is an internal pointer and should not be freed or
5221     * altered. It will also become invalid when the button is destroyed.
5222     * The string returned, if not NULL, is a stringshare, so if you need to
5223     * keep it around even after the button is destroyed, you can use
5224     * eina_stringshare_ref().
5225     *
5226     * @param obj The button object
5227     * @return The text set to the label, or NULL if nothing is set
5228     * @deprecated use elm_object_text_set() instead.
5229     */
5230    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5231    /**
5232     * Set the label for each state of button
5233     *
5234     * The passed @p label can be NULL to clean any existing text in it and
5235     * leave the button as an icon only object for the state.
5236     *
5237     * @param obj The button object
5238     * @param label The text will be written on the button
5239     * @param state The state of button
5240     *
5241     * @ingroup Button
5242     */
5243    EINA_DEPRECATED EAPI void         elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
5244    /**
5245     * Get the label of button for each state
5246     *
5247     * The string returned is an internal pointer and should not be freed or
5248     * altered. It will also become invalid when the button is destroyed.
5249     * The string returned, if not NULL, is a stringshare, so if you need to
5250     * keep it around even after the button is destroyed, you can use
5251     * eina_stringshare_ref().
5252     *
5253     * @param obj The button object
5254     * @param state The state of button
5255     * @return The title of button for state
5256     *
5257     * @ingroup Button
5258     */
5259    EINA_DEPRECATED EAPI const char  *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
5260    /**
5261     * Set the icon used for the button
5262     *
5263     * Setting a new icon will delete any other that was previously set, making
5264     * any reference to them invalid. If you need to maintain the previous
5265     * object alive, unset it first with elm_button_icon_unset().
5266     *
5267     * @param obj The button object
5268     * @param icon The icon object for the button
5269     */
5270    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5271    /**
5272     * Get the icon used for the button
5273     *
5274     * Return the icon object which is set for this widget. If the button is
5275     * destroyed or another icon is set, the returned object will be deleted
5276     * and any reference to it will be invalid.
5277     *
5278     * @param obj The button object
5279     * @return The icon object that is being used
5280     *
5281     * @see elm_button_icon_unset()
5282     */
5283    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5284    /**
5285     * Remove the icon set without deleting it and return the object
5286     *
5287     * This function drops the reference the button holds of the icon object
5288     * and returns this last object. It is used in case you want to remove any
5289     * icon, or set another one, without deleting the actual object. The button
5290     * will be left without an icon set.
5291     *
5292     * @param obj The button object
5293     * @return The icon object that was being used
5294     */
5295    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5296    /**
5297     * Turn on/off the autorepeat event generated when the button is kept pressed
5298     *
5299     * When off, no autorepeat is performed and buttons emit a normal @c clicked
5300     * signal when they are clicked.
5301     *
5302     * When on, keeping a button pressed will continuously emit a @c repeated
5303     * signal until the button is released. The time it takes until it starts
5304     * emitting the signal is given by
5305     * elm_button_autorepeat_initial_timeout_set(), and the time between each
5306     * new emission by elm_button_autorepeat_gap_timeout_set().
5307     *
5308     * @param obj The button object
5309     * @param on  A bool to turn on/off the event
5310     */
5311    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5312    /**
5313     * Get whether the autorepeat feature is enabled
5314     *
5315     * @param obj The button object
5316     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5317     *
5318     * @see elm_button_autorepeat_set()
5319     */
5320    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5321    /**
5322     * Set the initial timeout before the autorepeat event is generated
5323     *
5324     * Sets the timeout, in seconds, since the button is pressed until the
5325     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5326     * won't be any delay and the even will be fired the moment the button is
5327     * pressed.
5328     *
5329     * @param obj The button object
5330     * @param t   Timeout in seconds
5331     *
5332     * @see elm_button_autorepeat_set()
5333     * @see elm_button_autorepeat_gap_timeout_set()
5334     */
5335    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5336    /**
5337     * Get the initial timeout before the autorepeat event is generated
5338     *
5339     * @param obj The button object
5340     * @return Timeout in seconds
5341     *
5342     * @see elm_button_autorepeat_initial_timeout_set()
5343     */
5344    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5345    /**
5346     * Set the interval between each generated autorepeat event
5347     *
5348     * After the first @c repeated event is fired, all subsequent ones will
5349     * follow after a delay of @p t seconds for each.
5350     *
5351     * @param obj The button object
5352     * @param t   Interval in seconds
5353     *
5354     * @see elm_button_autorepeat_initial_timeout_set()
5355     */
5356    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5357    /**
5358     * Get the interval between each generated autorepeat event
5359     *
5360     * @param obj The button object
5361     * @return Interval in seconds
5362     */
5363    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5364    /**
5365     * @}
5366     */
5367
5368    /* fileselector */
5369    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5370    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5371    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5372    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5373    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5374    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5375    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
5376    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5377    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5378    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5379    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5380    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5381    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5382    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5383    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5384    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5385    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5386    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5387    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5388    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5389    /* available styles:
5390     * default
5391     * anchor
5392     * hoversel_vertical
5393     * hoversel_vertical_entry
5394     */
5395    /* smart callbacks called:
5396     * "file,chosen" - the user has selected a path, whose string pointer comes
5397                       as event info
5398     */
5399
5400    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5401    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5402    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5403    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5404    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5405    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5406    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
5407    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5408    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5409    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5410    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5411    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5412    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5413    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5414    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5415    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5416    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5417    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5418    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5419    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5420    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5421    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5422
5423    /* scroller policy */
5424    typedef enum _Elm_Scroller_Policy
5425      {
5426         ELM_SCROLLER_POLICY_AUTO = 0,
5427         ELM_SCROLLER_POLICY_ON,
5428         ELM_SCROLLER_POLICY_OFF,
5429         ELM_SCROLLER_POLICY_LAST
5430      } Elm_Scroller_Policy;
5431
5432    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5433    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
5434    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5435    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5436    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
5437    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
5438    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);
5439    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5440    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
5441    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);
5442    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5443    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5444    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5445    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5446    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5447    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);
5448    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5449    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
5450    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
5451    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
5452    EINA_DEPRECATED EAPI void         elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
5453    /* smart callbacks called:
5454     * "edge,left" - the left edge of the content has been reached
5455     * "edge,right" - the right edge of the content has been reached
5456     * "edge,top" - the top edge of the content has been reached
5457     * "edge,bottom" - the bottom edge of the content has been reached
5458     * "scroll" - the content has been scrolled (moved)
5459     * "scroll,anim,start" - scrolling animation has started
5460     * "scroll,anim,stop" - scrolling animation has stopped
5461     * "scroll,drag,start" - dragging the contents around has started
5462     * "scroll,drag,stop" - dragging the contents around has stopped
5463     */
5464
5465    /* label */
5466    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5467    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 */
5468    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5469    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5470    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5471    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5472    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5473    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5474    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5475    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5476    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);
5477    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5478    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);
5479    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5480    EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
5481    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5482    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5483    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5484    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5485    /* available styles:
5486     * default
5487     * marker
5488     */
5489    /* smart callbacks called:
5490     */
5491
5492    /* toggle */
5493    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5494    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5495    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5496    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5497    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5498    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5499    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5500    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5501    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5502    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5503    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5504    /* smart callbacks called:
5505     * "changed" - Whenever the toggle value has been changed.  Is not called
5506     *             until the toggle is released by the cursor (assuming it has been triggered
5507     *             by the cursor in the first place).
5508     */
5509
5510    /**
5511     * @page tutorial_frame Frame example
5512     * @dontinclude frame_example_01.c
5513     *
5514     * In this example we are going to create 4 Frames with different styles and
5515     * add a rectangle of different color in each.
5516     *
5517     * We start we the usual setup code:
5518     * @until show(bg)
5519     *
5520     * And then create one rectangle:
5521     * @until show
5522     *
5523     * To add it in our first frame, which since it doesn't have it's style
5524     * specifically set uses the default style:
5525     * @until show
5526     *
5527     * And then create another rectangle:
5528     * @until show
5529     *
5530     * To add it in our second frame, which uses the "pad_small" style, note that
5531     * even tough we are setting a text for this frame it won't be show, only the
5532     * default style shows the Frame's title:
5533     * @until show
5534     * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
5535     * very similar, their only difference is the size of the empty area around
5536     * the content of the frame.
5537     *
5538     * And then create yet another rectangle:
5539     * @until show
5540     *
5541     * To add it in our third frame, which uses the "outdent_top" style, note
5542     * that even tough we are setting a text for this frame it won't be show,
5543     * only the default style shows the Frame's title:
5544     * @until show
5545     *
5546     * And then create one last rectangle:
5547     * @until show
5548     *
5549     * To add it in our fourth and final frame, which uses the "outdent_bottom"
5550     * style, note that even tough we are setting a text for this frame it won't
5551     * be show, only the default style shows the Frame's title:
5552     * @until show
5553     *
5554     * And now we are left with just some more setup code:
5555     * @until ELM_MAIN()
5556     *
5557     * Our example will look like this:
5558     * @image html screenshots/frame_example_01.png
5559     * @image latex screenshots/frame_example_01.eps
5560     *
5561     * @example frame_example_01.c
5562     */
5563    /**
5564     * @defgroup Frame Frame
5565     *
5566     * @brief Frame is a widget that holds some content and has a title.
5567     *
5568     * The default look is a frame with a title, but Frame supports multple
5569     * styles:
5570     * @li default
5571     * @li pad_small
5572     * @li pad_medium
5573     * @li pad_large
5574     * @li pad_huge
5575     * @li outdent_top
5576     * @li outdent_bottom
5577     *
5578     * Of all this styles only default shows the title. Frame emits no signals.
5579     *
5580     * For a detailed example see the @ref tutorial_frame.
5581     *
5582     * @{
5583     */
5584    /**
5585     * @brief Add a new frame to the parent
5586     *
5587     * @param parent The parent object
5588     * @return The new object or NULL if it cannot be created
5589     */
5590    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5591    /**
5592     * @brief Set the frame label
5593     *
5594     * @param obj The frame object
5595     * @param label The label of this frame object
5596     *
5597     * @deprecated use elm_object_text_set() instead.
5598     */
5599    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5600    /**
5601     * @brief Get the frame label
5602     *
5603     * @param obj The frame object
5604     *
5605     * @return The label of this frame objet or NULL if unable to get frame
5606     *
5607     * @deprecated use elm_object_text_get() instead.
5608     */
5609    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5610    /**
5611     * @brief Set the content of the frame widget
5612     *
5613     * Once the content object is set, a previously set one will be deleted.
5614     * If you want to keep that old content object, use the
5615     * elm_frame_content_unset() function.
5616     *
5617     * @param obj The frame object
5618     * @param content The content will be filled in this frame object
5619     */
5620    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5621    /**
5622     * @brief Get the content of the frame widget
5623     *
5624     * Return the content object which is set for this widget
5625     *
5626     * @param obj The frame object
5627     * @return The content that is being used
5628     */
5629    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5630    /**
5631     * @brief Unset the content of the frame widget
5632     *
5633     * Unparent and return the content object which was set for this widget
5634     *
5635     * @param obj The frame object
5636     * @return The content that was being used
5637     */
5638    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5639    /**
5640     * @}
5641     */
5642
5643    /* table */
5644    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5645    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5646    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5647    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5648    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5649    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5650    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5651    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5652    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5653    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5654    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5655    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5656
5657    /* gengrid */
5658    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
5659    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
5660    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
5661    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5662    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
5663    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5664    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj);
5665
5666    struct _Elm_Gengrid_Item_Class
5667      {
5668         const char             *item_style;
5669         struct _Elm_Gengrid_Item_Class_Func
5670           {
5671              GridItemLabelGetFunc  label_get;
5672              GridItemIconGetFunc   icon_get;
5673              GridItemStateGetFunc  state_get;
5674              GridItemDelFunc       del;
5675           } func;
5676      };
5677
5678    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5679    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5680    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5681    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
5682    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
5683
5684    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5685    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5686    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5687    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5688    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5689    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5690    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5691    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5692    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5693    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5694    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5695    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
5696    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5697    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
5698    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5699
5700    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5701    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5702
5703    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5704    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5705    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5706    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5707    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5708    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5709    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
5710    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5711    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
5712    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
5713    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5714    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5715    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5716    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5717    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5718    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5719    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5720
5721    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
5722    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);
5723    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5724    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
5725    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5726    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5727    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5728    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5729    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
5730    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5731    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5732    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
5733
5734    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5735    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5736    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5737
5738    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);
5739    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);
5740    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);
5741    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);
5742    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);
5743    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);
5744    /* smart callbacks called:
5745     *
5746     * selected - User has selected an item.
5747     * unselected - User has unselected an item.
5748     * clicked,double - User has double-clicked or pressed enter on an item.
5749     * realized - An evas object for an item was built.
5750     * unrealized - An evas object for an item was deleted.
5751     * changed - An item has been added, removed, resized or moved,
5752     * or gengrid has been resized or horizontal property has been changed.
5753     * scroll - the content has been scrolled (moved).
5754     * "scroll,anim,start" - This is called when scrolling animation has started.
5755     * "scroll,anim,stop" - This is called when scrolling animation has stopped.
5756     * "scroll,drag,start" - dragging the contents around has started.
5757     * "scroll,drag,stop" - dragging the contents around has stopped.
5758     * drag - Gengrid is being dragged.
5759     * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
5760     * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
5761     * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
5762     * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
5763     * "drag,stop" - Gengrid is not being dragged.
5764     */
5765
5766    /**
5767     * @defgroup Clock Clock
5768     *
5769     * This is a @b digital clock widget. In its default theme, it has a
5770     * vintage "flipping numbers clock" appearance, which will animate
5771     * sheets of individual algarisms individually as time goes by.
5772     *
5773     * A newly created clock will fetch system's time (already
5774     * considering local time adjustments) to start with, and will tick
5775     * accondingly. It may or may not show seconds.
5776     *
5777     * Clocks have an @b edition mode. When in it, the sheets will
5778     * display extra arrow indications on the top and bottom and the
5779     * user may click on them to raise or lower the time values. After
5780     * it's told to exit edition mode, it will keep ticking with that
5781     * new time set (it keeps the difference from local time).
5782     *
5783     * Also, when under edition mode, user clicks on the cited arrows
5784     * which are @b held for some time will make the clock to flip the
5785     * sheet, thus editing the time, continuosly and automatically for
5786     * the user. The interval between sheet flips will keep growing in
5787     * time, so that it helps the user to reach a time which is distant
5788     * from the one set.
5789     *
5790     * The time display is, by default, in military mode (24h), but an
5791     * am/pm indicator may be optionally shown, too, when it will
5792     * switch to 12h.
5793     *
5794     * Smart callbacks one can register to:
5795     * - "changed" - the clock's user changed the time
5796     *
5797     * Here is an example on its usage:
5798     * @li @ref clock_example
5799     */
5800
5801    /**
5802     * @addtogroup Clock
5803     * @{
5804     */
5805
5806    /**
5807     * Identifiers for which clock digits should be editable, when a
5808     * clock widget is in edition mode. Values may be ORed together to
5809     * make a mask, naturally.
5810     *
5811     * @see elm_clock_edit_set()
5812     * @see elm_clock_digit_edit_set()
5813     */
5814    typedef enum _Elm_Clock_Digedit
5815      {
5816         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
5817         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
5818         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
5819         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
5820         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
5821         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
5822         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
5823         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
5824      } Elm_Clock_Digedit;
5825
5826    /**
5827     * Add a new clock widget to the given parent Elementary
5828     * (container) object
5829     *
5830     * @param parent The parent object
5831     * @return a new clock widget handle or @c NULL, on errors
5832     *
5833     * This function inserts a new clock widget on the canvas.
5834     *
5835     * @ingroup Clock
5836     */
5837    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5838
5839    /**
5840     * Set a clock widget's time, programmatically
5841     *
5842     * @param obj The clock widget object
5843     * @param hrs The hours to set
5844     * @param min The minutes to set
5845     * @param sec The secondes to set
5846     *
5847     * This function updates the time that is showed by the clock
5848     * widget.
5849     *
5850     *  Values @b must be set within the following ranges:
5851     * - 0 - 23, for hours
5852     * - 0 - 59, for minutes
5853     * - 0 - 59, for seconds,
5854     *
5855     * even if the clock is not in "military" mode.
5856     *
5857     * @warning The behavior for values set out of those ranges is @b
5858     * indefined.
5859     *
5860     * @ingroup Clock
5861     */
5862    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
5863
5864    /**
5865     * Get a clock widget's time values
5866     *
5867     * @param obj The clock object
5868     * @param[out] hrs Pointer to the variable to get the hours value
5869     * @param[out] min Pointer to the variable to get the minutes value
5870     * @param[out] sec Pointer to the variable to get the seconds value
5871     *
5872     * This function gets the time set for @p obj, returning
5873     * it on the variables passed as the arguments to function
5874     *
5875     * @note Use @c NULL pointers on the time values you're not
5876     * interested in: they'll be ignored by the function.
5877     *
5878     * @ingroup Clock
5879     */
5880    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
5881
5882    /**
5883     * Set whether a given clock widget is under <b>edition mode</b> or
5884     * under (default) displaying-only mode.
5885     *
5886     * @param obj The clock object
5887     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
5888     * put it back to "displaying only" mode
5889     *
5890     * This function makes a clock's time to be editable or not <b>by
5891     * user interaction</b>. When in edition mode, clocks @b stop
5892     * ticking, until one brings them back to canonical mode. The
5893     * elm_clock_digit_edit_set() function will influence which digits
5894     * of the clock will be editable. By default, all of them will be
5895     * (#ELM_CLOCK_NONE).
5896     *
5897     * @note am/pm sheets, if being shown, will @b always be editable
5898     * under edition mode.
5899     *
5900     * @see elm_clock_edit_get()
5901     *
5902     * @ingroup Clock
5903     */
5904    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
5905
5906    /**
5907     * Retrieve whether a given clock widget is under <b>edition
5908     * mode</b> or under (default) displaying-only mode.
5909     *
5910     * @param obj The clock object
5911     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
5912     * otherwise
5913     *
5914     * This function retrieves whether the clock's time can be edited
5915     * or not by user interaction.
5916     *
5917     * @see elm_clock_edit_set() for more details
5918     *
5919     * @ingroup Clock
5920     */
5921    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5922
5923    /**
5924     * Set what digits of the given clock widget should be editable
5925     * when in edition mode.
5926     *
5927     * @param obj The clock object
5928     * @param digedit Bit mask indicating the digits to be editable
5929     * (values in #Elm_Clock_Digedit).
5930     *
5931     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
5932     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
5933     * EINA_FALSE).
5934     *
5935     * @see elm_clock_digit_edit_get()
5936     *
5937     * @ingroup Clock
5938     */
5939    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
5940
5941    /**
5942     * Retrieve what digits of the given clock widget should be
5943     * editable when in edition mode.
5944     *
5945     * @param obj The clock object
5946     * @return Bit mask indicating the digits to be editable
5947     * (values in #Elm_Clock_Digedit).
5948     *
5949     * @see elm_clock_digit_edit_set() for more details
5950     *
5951     * @ingroup Clock
5952     */
5953    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5954
5955    /**
5956     * Set if the given clock widget must show hours in military or
5957     * am/pm mode
5958     *
5959     * @param obj The clock object
5960     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
5961     * to military mode
5962     *
5963     * This function sets if the clock must show hours in military or
5964     * am/pm mode. In some countries like Brazil the military mode
5965     * (00-24h-format) is used, in opposition to the USA, where the
5966     * am/pm mode is more commonly used.
5967     *
5968     * @see elm_clock_show_am_pm_get()
5969     *
5970     * @ingroup Clock
5971     */
5972    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
5973
5974    /**
5975     * Get if the given clock widget shows hours in military or am/pm
5976     * mode
5977     *
5978     * @param obj The clock object
5979     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
5980     * military
5981     *
5982     * This function gets if the clock shows hours in military or am/pm
5983     * mode.
5984     *
5985     * @see elm_clock_show_am_pm_set() for more details
5986     *
5987     * @ingroup Clock
5988     */
5989    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5990
5991    /**
5992     * Set if the given clock widget must show time with seconds or not
5993     *
5994     * @param obj The clock object
5995     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
5996     *
5997     * This function sets if the given clock must show or not elapsed
5998     * seconds. By default, they are @b not shown.
5999     *
6000     * @see elm_clock_show_seconds_get()
6001     *
6002     * @ingroup Clock
6003     */
6004    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
6005
6006    /**
6007     * Get whether the given clock widget is showing time with seconds
6008     * or not
6009     *
6010     * @param obj The clock object
6011     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
6012     *
6013     * This function gets whether @p obj is showing or not the elapsed
6014     * seconds.
6015     *
6016     * @see elm_clock_show_seconds_set()
6017     *
6018     * @ingroup Clock
6019     */
6020    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6021
6022    /**
6023     * Set the interval on time updates for an user mouse button hold
6024     * on clock widgets' time edition.
6025     *
6026     * @param obj The clock object
6027     * @param interval The (first) interval value in seconds
6028     *
6029     * This interval value is @b decreased while the user holds the
6030     * mouse pointer either incrementing or decrementing a given the
6031     * clock digit's value.
6032     *
6033     * This helps the user to get to a given time distant from the
6034     * current one easier/faster, as it will start to flip quicker and
6035     * quicker on mouse button holds.
6036     *
6037     * The calculation for the next flip interval value, starting from
6038     * the one set with this call, is the previous interval divided by
6039     * 1.05, so it decreases a little bit.
6040     *
6041     * The default starting interval value for automatic flips is
6042     * @b 0.85 seconds.
6043     *
6044     * @see elm_clock_interval_get()
6045     *
6046     * @ingroup Clock
6047     */
6048    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6049
6050    /**
6051     * Get the interval on time updates for an user mouse button hold
6052     * on clock widgets' time edition.
6053     *
6054     * @param obj The clock object
6055     * @return The (first) interval value, in seconds, set on it
6056     *
6057     * @see elm_clock_interval_set() for more details
6058     *
6059     * @ingroup Clock
6060     */
6061    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6062
6063    /**
6064     * @}
6065     */
6066
6067    /* layout */
6068    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6069    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
6070    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
6071    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
6072    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6073    EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6074    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
6075    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
6076    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
6077    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
6078    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
6079    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
6080    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
6081    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
6082    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);
6083    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
6084    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
6085    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6086    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
6087    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
6088    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
6089    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6090    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6091    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
6092    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6093    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);
6094    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
6095 /**
6096  * @def elm_layout_icon_set
6097  * Convienience macro to set the icon object in a layout that follows the
6098  * Elementary naming convention for its parts.
6099  *
6100  * @ingroup Layout
6101  */
6102 #define elm_layout_icon_set(_ly, _obj) \
6103   do { \
6104     const char *sig; \
6105     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
6106     if ((_obj)) sig = "elm,state,icon,visible"; \
6107     else sig = "elm,state,icon,hidden"; \
6108     elm_object_signal_emit((_ly), sig, "elm"); \
6109   } while (0)
6110
6111 /**
6112  * @def elm_layout_icon_get
6113  * Convienience macro to get the icon object from a layout that follows the
6114  * Elementary naming convention for its parts.
6115  *
6116  * @ingroup Layout
6117  */
6118 #define elm_layout_icon_get(_ly) \
6119   elm_layout_content_get((_ly), "elm.swallow.icon")
6120
6121 /**
6122  * @def elm_layout_end_set
6123  * Convienience macro to set the end object in a layout that follows the
6124  * Elementary naming convention for its parts.
6125  *
6126  * @ingroup Layout
6127  */
6128 #define elm_layout_end_set(_ly, _obj) \
6129   do { \
6130     const char *sig; \
6131     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
6132     if ((_obj)) sig = "elm,state,end,visible"; \
6133     else sig = "elm,state,end,hidden"; \
6134     elm_object_signal_emit((_ly), sig, "elm"); \
6135   } while (0)
6136
6137 /**
6138  * @def elm_layout_end_get
6139  * Convienience macro to get the end object in a layout that follows the
6140  * Elementary naming convention for its parts.
6141  *
6142  * @ingroup Layout
6143  */
6144 #define elm_layout_end_get(_ly) \
6145   elm_layout_content_get((_ly), "elm.swallow.end")
6146
6147 /**
6148  * @def elm_layout_label_set
6149  * Convienience macro to set the label in a layout that follows the
6150  * Elementary naming convention for its parts.
6151  *
6152  * @ingroup Layout
6153  * @deprecate use elm_object_text_* instead.
6154  */
6155 #define elm_layout_label_set(_ly, _txt) \
6156   elm_layout_text_set((_ly), "elm.text", (_txt))
6157
6158 /**
6159  * @def elm_layout_label_get
6160  * Convienience macro to get the label in a layout that follows the
6161  * Elementary naming convention for its parts.
6162  *
6163  * @ingroup Layout
6164  * @deprecate use elm_object_text_* instead.
6165  */
6166 #define elm_layout_label_get(_ly) \
6167   elm_layout_text_get((_ly), "elm.text")
6168
6169    /* smart callbacks called:
6170     */
6171
6172    /* notify */
6173    typedef enum _Elm_Notify_Orient
6174      {
6175         ELM_NOTIFY_ORIENT_TOP,
6176         ELM_NOTIFY_ORIENT_CENTER,
6177         ELM_NOTIFY_ORIENT_BOTTOM,
6178         ELM_NOTIFY_ORIENT_LEFT,
6179         ELM_NOTIFY_ORIENT_RIGHT,
6180         ELM_NOTIFY_ORIENT_TOP_LEFT,
6181         ELM_NOTIFY_ORIENT_TOP_RIGHT,
6182         ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
6183         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
6184         ELM_NOTIFY_ORIENT_LAST
6185      } Elm_Notify_Orient;
6186    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6187    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6188    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6189    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6190    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6191    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6192    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
6193    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6194    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
6195    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6196    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
6197    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6198    /* smart callbacks called:
6199     * "timeout" - when timeout happens on notify and it's hidden
6200     * "block,clicked" - when it's hidden by a click outside of the notify's view
6201     */
6202
6203    /* hover */
6204    typedef enum _Elm_Hover_Axis
6205      {
6206         ELM_HOVER_AXIS_NONE,
6207         ELM_HOVER_AXIS_HORIZONTAL,
6208         ELM_HOVER_AXIS_VERTICAL,
6209         ELM_HOVER_AXIS_BOTH
6210      } Elm_Hover_Axis;
6211    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6212    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
6213    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6214    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6215    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6216    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
6217    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6218    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
6219    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
6220    /* available styles:
6221     * default
6222     * popout
6223     * menu
6224     * hoversel_vertical
6225     */
6226    /* smart callbacks called:
6227     * "clicked" - the user clicked the empty space in the hover to dismiss
6228     * "smart,changed" - a content object placed under the "smart"
6229     *                   policy was replaced to a new slot direction.
6230     */
6231
6232    /* entry */
6233    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
6234    struct _Elm_Entry_Anchor_Info
6235      {
6236         const char *name;
6237         int         button;
6238         Evas_Coord  x, y, w, h;
6239      };
6240    typedef enum _Elm_Icon_Type
6241      {
6242         ELM_ICON_NONE,
6243         ELM_ICON_FILE,
6244         ELM_ICON_STANDARD
6245      } Elm_Icon_Type;
6246
6247    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
6248
6249    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6250    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
6251    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6252    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
6253    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6254    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6255    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6256    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6257    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6258    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6259    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6260    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6261    EINA_DEPRECATED EAPI void         elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6262    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6263    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6264    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6265    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
6266    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6267    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6268    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6269    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
6270    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
6271    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6272    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6273    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6274    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6275    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6276    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6277    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6278    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6279    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6280    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);
6281    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6282    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6283    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
6284    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
6285    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6286    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6287    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);
6288    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6289    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6290    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);
6291    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);
6292    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);
6293    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);
6294    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);
6295    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);
6296    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
6297    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
6298    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6299    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6300    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6301    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6302    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6303    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6304    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6305    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
6306    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
6307    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
6308    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
6309    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
6310    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
6311    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
6312    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
6313    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
6314    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
6315    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
6316    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
6317    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
6318
6319    /* pre-made filters for entries */
6320    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
6321    struct _Elm_Entry_Filter_Limit_Size
6322      {
6323         int max_char_count;
6324         int max_byte_count;
6325      };
6326    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
6327    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
6328    struct _Elm_Entry_Filter_Accept_Set
6329      {
6330         const char *accepted;
6331         const char *rejected;
6332      };
6333    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
6334    /**
6335     * Set the input panel layout of the entry
6336     *
6337     * @param obj The entry object
6338     * @param layout layout type
6339     */
6340    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
6341    /**
6342     * Get the input panel layout of the entry
6343     *
6344     * @param obj The entry object
6345     * @return layout type
6346     *
6347     * @see elm_entry_input_panel_layout_set
6348     */
6349    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6350    /**
6351     * Set the autocapitalization type on the immodule.
6352     *
6353     * @param obj The entry object
6354     * @param autocapital_type The type of autocapitalization
6355     */
6356    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
6357    /**
6358     * Retrieve the autocapitalization type on the immodule.
6359     *
6360     * @param obj The entry object
6361     * @return autocapitalization type
6362     */
6363    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6364    /**
6365     * Sets the attribute to show the input panel automatically.
6366     *
6367     * @param obj The entry object
6368     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
6369     */
6370    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6371    /**
6372     * Retrieve the attribute to show the input panel automatically.
6373     *
6374     * @param obj The entry object
6375     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
6376     */
6377    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6378
6379    EAPI void         elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
6380    EAPI void         elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6381    EAPI void         elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6382    EAPI void         elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
6383    EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
6384    EAPI void         elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
6385    EAPI void         elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
6386
6387    EINA_DEPRECATED EAPI void         elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
6388    EINA_DEPRECATED EAPI Evas_Coord   elm_entry_wrap_width_get(const Evas_Object *obj);
6389    EINA_DEPRECATED EAPI void         elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
6390    EINA_DEPRECATED EAPI void         elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
6391    EINA_DEPRECATED EAPI void         elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
6392
6393    /* smart callbacks called:
6394     * "changed" - the text content changed
6395     * "selection,start" - the user started selecting text
6396     * "selection,changed" - the user modified the selection size/location
6397     * "selection,cleared" - the user cleared the selection
6398     * "selection,paste" - the user requested a paste of text
6399     * "selection,copy" - the user copied the text
6400     * "selection,cut" - the user cut the text
6401     * "cursor,changed" - the cursor changed position
6402     * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
6403     * "activated" - when the enter key is pressed (useful for single line)
6404     * "press" - when finger/mouse is pressed down
6405     * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
6406     * "clicked,double" - when finger/mouse is double-pressed
6407     * "longpressed" - the entry has been longpressed
6408     * "focused" - the entry has received keyboard focus
6409     * "unfocused" - keyboard focus is gone
6410     */
6411
6412    /* composite widgets - these basically put together basic widgets above
6413     * in convenient packages that do more than basic stuff */
6414
6415    /* anchorview */
6416    /**
6417     * @defgroup Anchorview Anchorview
6418     *
6419     * Anchorview is for displaying text that contains markup with anchors
6420     * like <c>\<a href=1234\>something\</\></c> in it.
6421     *
6422     * Besides being styled differently, the anchorview widget provides the
6423     * necessary functionality so that clicking on these anchors brings up a
6424     * popup with user defined content such as "call", "add to contacts" or
6425     * "open web page". This popup is provided using the @ref Hover widget.
6426     *
6427     * This widget is very similar to @ref Anchorblock, so refer to that
6428     * widget for an example. The only difference Anchorview has is that the
6429     * widget is already provided with scrolling functionality, so if the
6430     * text set to it is too large to fit in the given space, it will scroll,
6431     * whereas the @ref Anchorblock widget will keep growing to ensure all the
6432     * text can be displayed.
6433     *
6434     * This widget emits the following signals:
6435     * @li "anchor,clicked": will be called when an anchor is clicked. The
6436     * @p event_info parameter on the callback will be a pointer of type
6437     * ::Elm_Entry_Anchorview_Info.
6438     *
6439     * See @ref Anchorblock for an example on how to use both of them.
6440     *
6441     * @see Anchorblock
6442     * @see Entry
6443     * @see Hover
6444     *
6445     * @{
6446     */
6447    /**
6448     * @typedef Elm_Entry_Anchorview_Info
6449     *
6450     * The info sent in the callback for "anchor,clicked" signals emitted by
6451     * the Anchorview widget.
6452     */
6453    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
6454    /**
6455     * @struct _Elm_Entry_Anchorview_Info
6456     *
6457     * The info sent in the callback for "anchor,clicked" signals emitted by
6458     * the Anchorview widget.
6459     */
6460    struct _Elm_Entry_Anchorview_Info
6461      {
6462         const char     *name; /**< Name of the anchor, as indicated in its href
6463                                    attribute */
6464         int             button; /**< The mouse button used to click on it */
6465         Evas_Object    *hover; /**< The hover object to use for the popup */
6466         struct {
6467              Evas_Coord    x, y, w, h;
6468         } anchor, /**< Geometry selection of text used as anchor */
6469           hover_parent; /**< Geometry of the object used as parent by the
6470                              hover */
6471         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
6472                                              for content on the left side of
6473                                              the hover. Before calling the
6474                                              callback, the widget will make the
6475                                              necessary calculations to check
6476                                              which sides are fit to be set with
6477                                              content, based on the position the
6478                                              hover is activated and its distance
6479                                              to the edges of its parent object
6480                                              */
6481         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
6482                                               the right side of the hover.
6483                                               See @ref hover_left */
6484         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
6485                                             of the hover. See @ref hover_left */
6486         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
6487                                                below the hover. See @ref
6488                                                hover_left */
6489      };
6490    /**
6491     * Add a new Anchorview object
6492     *
6493     * @param parent The parent object
6494     * @return The new object or NULL if it cannot be created
6495     */
6496    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6497    /**
6498     * Set the text to show in the anchorview
6499     *
6500     * Sets the text of the anchorview to @p text. This text can include markup
6501     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
6502     * text that will be specially styled and react to click events, ended with
6503     * either of \</a\> or \</\>. When clicked, the anchor will emit an
6504     * "anchor,clicked" signal that you can attach a callback to with
6505     * evas_object_smart_callback_add(). The name of the anchor given in the
6506     * event info struct will be the one set in the href attribute, in this
6507     * case, anchorname.
6508     *
6509     * Other markup can be used to style the text in different ways, but it's
6510     * up to the style defined in the theme which tags do what.
6511     * @deprecated use elm_object_text_set() instead.
6512     */
6513    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
6514    /**
6515     * Get the markup text set for the anchorview
6516     *
6517     * Retrieves the text set on the anchorview, with markup tags included.
6518     *
6519     * @param obj The anchorview object
6520     * @return The markup text set or @c NULL if nothing was set or an error
6521     * occurred
6522     * @deprecated use elm_object_text_set() instead.
6523     */
6524    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6525    /**
6526     * Set the parent of the hover popup
6527     *
6528     * Sets the parent object to use by the hover created by the anchorview
6529     * when an anchor is clicked. See @ref Hover for more details on this.
6530     * If no parent is set, the same anchorview object will be used.
6531     *
6532     * @param obj The anchorview object
6533     * @param parent The object to use as parent for the hover
6534     */
6535    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6536    /**
6537     * Get the parent of the hover popup
6538     *
6539     * Get the object used as parent for the hover created by the anchorview
6540     * widget. See @ref Hover for more details on this.
6541     *
6542     * @param obj The anchorview object
6543     * @return The object used as parent for the hover, NULL if none is set.
6544     */
6545    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6546    /**
6547     * Set the style that the hover should use
6548     *
6549     * When creating the popup hover, anchorview will request that it's
6550     * themed according to @p style.
6551     *
6552     * @param obj The anchorview object
6553     * @param style The style to use for the underlying hover
6554     *
6555     * @see elm_object_style_set()
6556     */
6557    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
6558    /**
6559     * Get the style that the hover should use
6560     *
6561     * Get the style the hover created by anchorview will use.
6562     *
6563     * @param obj The anchorview object
6564     * @return The style to use by the hover. NULL means the default is used.
6565     *
6566     * @see elm_object_style_set()
6567     */
6568    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6569    /**
6570     * Ends the hover popup in the anchorview
6571     *
6572     * When an anchor is clicked, the anchorview widget will create a hover
6573     * object to use as a popup with user provided content. This function
6574     * terminates this popup, returning the anchorview to its normal state.
6575     *
6576     * @param obj The anchorview object
6577     */
6578    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6579    /**
6580     * Set bouncing behaviour when the scrolled content reaches an edge
6581     *
6582     * Tell the internal scroller object whether it should bounce or not
6583     * when it reaches the respective edges for each axis.
6584     *
6585     * @param obj The anchorview object
6586     * @param h_bounce Whether to bounce or not in the horizontal axis
6587     * @param v_bounce Whether to bounce or not in the vertical axis
6588     *
6589     * @see elm_scroller_bounce_set()
6590     */
6591    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6592    /**
6593     * Get the set bouncing behaviour of the internal scroller
6594     *
6595     * Get whether the internal scroller should bounce when the edge of each
6596     * axis is reached scrolling.
6597     *
6598     * @param obj The anchorview object
6599     * @param h_bounce Pointer where to store the bounce state of the horizontal
6600     *                 axis
6601     * @param v_bounce Pointer where to store the bounce state of the vertical
6602     *                 axis
6603     *
6604     * @see elm_scroller_bounce_get()
6605     */
6606    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6607    /**
6608     * Appends a custom item provider to the given anchorview
6609     *
6610     * Appends the given function to the list of items providers. This list is
6611     * called, one function at a time, with the given @p data pointer, the
6612     * anchorview object and, in the @p item parameter, the item name as
6613     * referenced in its href string. Following functions in the list will be
6614     * called in order until one of them returns something different to NULL,
6615     * which should be an Evas_Object which will be used in place of the item
6616     * element.
6617     *
6618     * Items in the markup text take the form \<item relsize=16x16 vsize=full
6619     * href=item/name\>\</item\>
6620     *
6621     * @param obj The anchorview object
6622     * @param func The function to add to the list of providers
6623     * @param data User data that will be passed to the callback function
6624     *
6625     * @see elm_entry_item_provider_append()
6626     */
6627    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);
6628    /**
6629     * Prepend a custom item provider to the given anchorview
6630     *
6631     * Like elm_anchorview_item_provider_append(), but it adds the function
6632     * @p func to the beginning of the list, instead of the end.
6633     *
6634     * @param obj The anchorview object
6635     * @param func The function to add to the list of providers
6636     * @param data User data that will be passed to the callback function
6637     */
6638    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);
6639    /**
6640     * Remove a custom item provider from the list of the given anchorview
6641     *
6642     * Removes the function and data pairing that matches @p func and @p data.
6643     * That is, unless the same function and same user data are given, the
6644     * function will not be removed from the list. This allows us to add the
6645     * same callback several times, with different @p data pointers and be
6646     * able to remove them later without conflicts.
6647     *
6648     * @param obj The anchorview object
6649     * @param func The function to remove from the list
6650     * @param data The data matching the function to remove from the list
6651     */
6652    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);
6653    /**
6654     * @}
6655     */
6656
6657    /* anchorblock */
6658    /**
6659     * @defgroup Anchorblock Anchorblock
6660     *
6661     * Anchorblock is for displaying text that contains markup with anchors
6662     * like <c>\<a href=1234\>something\</\></c> in it.
6663     *
6664     * Besides being styled differently, the anchorblock widget provides the
6665     * necessary functionality so that clicking on these anchors brings up a
6666     * popup with user defined content such as "call", "add to contacts" or
6667     * "open web page". This popup is provided using the @ref Hover widget.
6668     *
6669     * This widget emits the following signals:
6670     * @li "anchor,clicked": will be called when an anchor is clicked. The
6671     * @p event_info parameter on the callback will be a pointer of type
6672     * ::Elm_Entry_Anchorblock_Info.
6673     *
6674     * @see Anchorview
6675     * @see Entry
6676     * @see Hover
6677     *
6678     * Since examples are usually better than plain words, we might as well
6679     * try @ref tutorial_anchorblock_example "one".
6680     */
6681    /**
6682     * @page tutorial_anchorblock_example Anchorblock/Anchorview example
6683     * This exampel will show both Anchorblock and @ref Anchorview,
6684     * since both are very similar and it's easier to show them once and side
6685     * by side, so the difference is more clear.
6686     *
6687     * We'll show the relevant snippets of the code here, but the full example
6688     * can be found here... sorry, @ref anchorblock_example_01.c "here".
6689     *
6690     * As for the actual example, it's just a simple window with an anchorblock
6691     * and an anchorview, both containing the same text. After including
6692     * Elementary.h and declaring some functions we'll need, we jump to our
6693     * elm_main (see ELM_MAIN) and create our window.
6694     * @dontinclude anchorblock_example_01.c
6695     * @skip int
6696     * @until const char
6697     * @until ;
6698     *
6699     * With the needed variables declared, we'll create the window and a box to
6700     * hold our widgets, but we don't need to go through that here.
6701     *
6702     * In order to make clear where the anchorblock ends and the anchorview
6703     * begins, they'll be each inside a @ref Frame. After creating the frame,
6704     * the anchorblock follows.
6705     * @skip elm_frame_add
6706     * @until elm_frame_content_set
6707     *
6708     * Nothing out of the ordinary there. What's worth mentioning is the call
6709     * to elm_anchorblock_hover_parent_set(). We are telling our widget that
6710     * when an anchor is clicked, the hover for the popup will cover the entire
6711     * window. This affects the area that will be obscured by the hover and
6712     * where clicking will dismiss it, as well as the calculations it does to
6713     * inform the best locations where to insert the popups content.
6714     * Other than that, the code is pretty standard. We also need to set our
6715     * callback for when an anchor is clicked, since it's our task to populate
6716     * the popup. There's no default for it.
6717     *
6718     * The anchorview is no different, we only change a few things so it looks
6719     * different.
6720     * @until elm_frame_content_set
6721     *
6722     * Then we run, so stuff works and close our main function in the usual way.
6723     * @until ELM_MAIN
6724     *
6725     * Now, a little note. Normally you would use either one of anchorblock or
6726     * anchorview, set your one callback to clicks and do your stuff in there.
6727     * In this example, however, there are a few tricks to make it easier to
6728     * show both widgets in one go (and to save me some typing). So we have
6729     * two callbacks, one per widget, that will call a common function to do
6730     * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
6731     * anchorview too, since both are equal, and passing a callback to use
6732     * for our buttons to end the hover, because each widget has a different
6733     * function for it.
6734     * @until _anchorview_clicked_cb
6735     * @until }
6736     *
6737     * The meat of our popup is in the following function. We check what kind
6738     * of menu we need to show, based on the name set to the anchor in the
6739     * markup text. If there's no type (something went wrong, no valid contact
6740     * in the address list) we are just putting a button that does nothing, but
6741     * it's perfectly reasonable to just end the hover and call it quits.
6742     *
6743     * Our popup will consist of one main button in the middle of our hover,
6744     * and possibly a secondary button and a list of other options. We'll create
6745     * first our main button and check what kind of popup we need afterwards.
6746     * @skip static void
6747     * @skip static void
6748     * @until eina_stringshare_add
6749     * @until }
6750     *
6751     * Each button has two callbacks, one is our hack to close the hover
6752     * properly based on which widget it belongs to, the other a simple
6753     * printf that will show the action with the anchors own data. This is
6754     * not how you would usually do it. Instead, the common case is to have
6755     * one callback for the button that will know which function to call to end
6756     * things, but since we are doing it this way it's worth noting that
6757     * smart callbacks will be called in reverse in respect to the order they
6758     * were added, and since our @c btn_end_cb will close the hover, and thus
6759     * delete our buttons, the other callback wouldn't be called if we had
6760     * added it before.
6761     *
6762     * After our telephone popup, there are a few others that are practically
6763     * the same, so they won't be shown here.
6764     *
6765     * Once we are done with that, it's time to place our actions into our
6766     * hover. Main button goes in the middle without much questioning, and then
6767     * we see if we have a secondary button and a box of extra options.
6768     * Because I said so, secondary button goes on either side and box of
6769     * options either on top or below the main one, but to choose which
6770     * exactly, we use the hints our callback info has, which saves us from
6771     * having to do the math and see which side has more space available, with
6772     * a little special case where we delete our extra stuff if there's nowhere
6773     * to place it.
6774     * @skip url:
6775     * @skip }
6776     * @skip evas_object_smart
6777     * @until evas_object_del(box)
6778     * @until }
6779     * @until }
6780     *
6781     * The example will look like this:
6782     * @image html screenshots/anchorblock_01.png
6783     * @image latex screenshots/anchorblock_01.eps
6784     *
6785     * @example anchorblock_example_01.c
6786     */
6787    /**
6788     * @addtogroup Anchorblock
6789     * @{
6790     */
6791    /**
6792     * @typedef Elm_Entry_Anchorblock_Info
6793     *
6794     * The info sent in the callback for "anchor,clicked" signals emitted by
6795     * the Anchorblock widget.
6796     */
6797    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
6798    /**
6799     * @struct _Elm_Entry_Anchorblock_Info
6800     *
6801     * The info sent in the callback for "anchor,clicked" signals emitted by
6802     * the Anchorblock widget.
6803     */
6804    struct _Elm_Entry_Anchorblock_Info
6805      {
6806         const char     *name; /**< Name of the anchor, as indicated in its href
6807                                    attribute */
6808         int             button; /**< The mouse button used to click on it */
6809         Evas_Object    *hover; /**< The hover object to use for the popup */
6810         struct {
6811              Evas_Coord    x, y, w, h;
6812         } anchor, /**< Geometry selection of text used as anchor */
6813           hover_parent; /**< Geometry of the object used as parent by the
6814                              hover */
6815         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
6816                                              for content on the left side of
6817                                              the hover. Before calling the
6818                                              callback, the widget will make the
6819                                              necessary calculations to check
6820                                              which sides are fit to be set with
6821                                              content, based on the position the
6822                                              hover is activated and its distance
6823                                              to the edges of its parent object
6824                                              */
6825         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
6826                                               the right side of the hover.
6827                                               See @ref hover_left */
6828         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
6829                                             of the hover. See @ref hover_left */
6830         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
6831                                                below the hover. See @ref
6832                                                hover_left */
6833      };
6834    /**
6835     * Add a new Anchorblock object
6836     *
6837     * @param parent The parent object
6838     * @return The new object or NULL if it cannot be created
6839     */
6840    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6841    /**
6842     * Set the text to show in the anchorblock
6843     *
6844     * Sets the text of the anchorblock to @p text. This text can include markup
6845     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
6846     * of text that will be specially styled and react to click events, ended
6847     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
6848     * "anchor,clicked" signal that you can attach a callback to with
6849     * evas_object_smart_callback_add(). The name of the anchor given in the
6850     * event info struct will be the one set in the href attribute, in this
6851     * case, anchorname.
6852     *
6853     * Other markup can be used to style the text in different ways, but it's
6854     * up to the style defined in the theme which tags do what.
6855     * @deprecated use elm_object_text_set() instead.
6856     */
6857    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
6858    /**
6859     * Get the markup text set for the anchorblock
6860     *
6861     * Retrieves the text set on the anchorblock, with markup tags included.
6862     *
6863     * @param obj The anchorblock object
6864     * @return The markup text set or @c NULL if nothing was set or an error
6865     * occurred
6866     * @deprecated use elm_object_text_set() instead.
6867     */
6868    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6869    /**
6870     * Set the parent of the hover popup
6871     *
6872     * Sets the parent object to use by the hover created by the anchorblock
6873     * when an anchor is clicked. See @ref Hover for more details on this.
6874     *
6875     * @param obj The anchorblock object
6876     * @param parent The object to use as parent for the hover
6877     */
6878    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
6879    /**
6880     * Get the parent of the hover popup
6881     *
6882     * Get the object used as parent for the hover created by the anchorblock
6883     * widget. See @ref Hover for more details on this.
6884     * If no parent is set, the same anchorblock object will be used.
6885     *
6886     * @param obj The anchorblock object
6887     * @return The object used as parent for the hover, NULL if none is set.
6888     */
6889    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6890    /**
6891     * Set the style that the hover should use
6892     *
6893     * When creating the popup hover, anchorblock will request that it's
6894     * themed according to @p style.
6895     *
6896     * @param obj The anchorblock object
6897     * @param style The style to use for the underlying hover
6898     *
6899     * @see elm_object_style_set()
6900     */
6901    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
6902    /**
6903     * Get the style that the hover should use
6904     *
6905     * Get the style the hover created by anchorblock will use.
6906     *
6907     * @param obj The anchorblock object
6908     * @return The style to use by the hover. NULL means the default is used.
6909     *
6910     * @see elm_object_style_set()
6911     */
6912    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6913    /**
6914     * Ends the hover popup in the anchorblock
6915     *
6916     * When an anchor is clicked, the anchorblock widget will create a hover
6917     * object to use as a popup with user provided content. This function
6918     * terminates this popup, returning the anchorblock to its normal state.
6919     *
6920     * @param obj The anchorblock object
6921     */
6922    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6923    /**
6924     * Appends a custom item provider to the given anchorblock
6925     *
6926     * Appends the given function to the list of items providers. This list is
6927     * called, one function at a time, with the given @p data pointer, the
6928     * anchorblock object and, in the @p item parameter, the item name as
6929     * referenced in its href string. Following functions in the list will be
6930     * called in order until one of them returns something different to NULL,
6931     * which should be an Evas_Object which will be used in place of the item
6932     * element.
6933     *
6934     * Items in the markup text take the form \<item relsize=16x16 vsize=full
6935     * href=item/name\>\</item\>
6936     *
6937     * @param obj The anchorblock object
6938     * @param func The function to add to the list of providers
6939     * @param data User data that will be passed to the callback function
6940     *
6941     * @see elm_entry_item_provider_append()
6942     */
6943    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);
6944    /**
6945     * Prepend a custom item provider to the given anchorblock
6946     *
6947     * Like elm_anchorblock_item_provider_append(), but it adds the function
6948     * @p func to the beginning of the list, instead of the end.
6949     *
6950     * @param obj The anchorblock object
6951     * @param func The function to add to the list of providers
6952     * @param data User data that will be passed to the callback function
6953     */
6954    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);
6955    /**
6956     * Remove a custom item provider from the list of the given anchorblock
6957     *
6958     * Removes the function and data pairing that matches @p func and @p data.
6959     * That is, unless the same function and same user data are given, the
6960     * function will not be removed from the list. This allows us to add the
6961     * same callback several times, with different @p data pointers and be
6962     * able to remove them later without conflicts.
6963     *
6964     * @param obj The anchorblock object
6965     * @param func The function to remove from the list
6966     * @param data The data matching the function to remove from the list
6967     */
6968    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);
6969    /**
6970     * @}
6971     */
6972
6973    /**
6974     * @defgroup Bubble Bubble
6975     *
6976     * @brief The Bubble is a widget to show text similarly to how speech is
6977     * represented in comics.
6978     *
6979     * The bubble widget contains 5 important visual elements:
6980     * @li The frame is a rectangle with rounded rectangles and an "arrow".
6981     * @li The @p icon is an image to which the frame's arrow points to.
6982     * @li The @p label is a text which appears to the right of the icon if the
6983     * corner is "top_left" or "bottom_left" and is right aligned to the frame
6984     * otherwise.
6985     * @li The @p info is a text which appears to the right of the label. Info's
6986     * font is of a ligther color than label.
6987     * @li The @p content is an evas object that is shown inside the frame.
6988     *
6989     * The position of the arrow, icon, label and info depends on which corner is
6990     * selected. The four available corners are:
6991     * @li "top_left" - Default
6992     * @li "top_right"
6993     * @li "bottom_left"
6994     * @li "bottom_right"
6995     *
6996     * Signals that you can add callbacks for are:
6997     * @li "clicked" - This is called when a user has clicked the bubble.
6998     *
6999     * For an example of using a buble see @ref bubble_01_example_page "this".
7000     *
7001     * @{
7002     */
7003    /**
7004     * Add a new bubble to the parent
7005     *
7006     * @param parent The parent object
7007     * @return The new object or NULL if it cannot be created
7008     *
7009     * This function adds a text bubble to the given parent evas object.
7010     */
7011    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7012    /**
7013     * Set the label of the bubble
7014     *
7015     * @param obj The bubble object
7016     * @param label The string to set in the label
7017     *
7018     * This function sets the title of the bubble. Where this appears depends on
7019     * the selected corner.
7020     * @deprecated use elm_object_text_set() instead.
7021     */
7022    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7023    /**
7024     * Get the label of the bubble
7025     *
7026     * @param obj The bubble object
7027     * @return The string of set in the label
7028     *
7029     * This function gets the title of the bubble.
7030     * @deprecated use elm_object_text_set() instead.
7031     */
7032    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7033    /**
7034     * Set the info of the bubble
7035     *
7036     * @param obj The bubble object
7037     * @param info The given info about the bubble
7038     *
7039     * This function sets the info of the bubble. Where this appears depends on
7040     * the selected corner.
7041     * @deprecated use elm_object_text_set() instead.
7042     */
7043    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
7044    /**
7045     * Get the info of the bubble
7046     *
7047     * @param obj The bubble object
7048     *
7049     * @return The "info" string of the bubble
7050     *
7051     * This function gets the info text.
7052     * @deprecated use elm_object_text_set() instead.
7053     */
7054    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7055    /**
7056     * Set the content to be shown in the bubble
7057     *
7058     * Once the content object is set, a previously set one will be deleted.
7059     * If you want to keep the old content object, use the
7060     * elm_bubble_content_unset() function.
7061     *
7062     * @param obj The bubble object
7063     * @param content The given content of the bubble
7064     *
7065     * This function sets the content shown on the middle of the bubble.
7066     */
7067    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7068    /**
7069     * Get the content shown in the bubble
7070     *
7071     * Return the content object which is set for this widget.
7072     *
7073     * @param obj The bubble object
7074     * @return The content that is being used
7075     */
7076    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7077    /**
7078     * Unset the content shown in the bubble
7079     *
7080     * Unparent and return the content object which was set for this widget.
7081     *
7082     * @param obj The bubble object
7083     * @return The content that was being used
7084     */
7085    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7086    /**
7087     * Set the icon of the bubble
7088     *
7089     * Once the icon object is set, a previously set one will be deleted.
7090     * If you want to keep the old content object, use the
7091     * elm_icon_content_unset() function.
7092     *
7093     * @param obj The bubble object
7094     * @param icon The given icon for the bubble
7095     */
7096    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7097    /**
7098     * Get the icon of the bubble
7099     *
7100     * @param obj The bubble object
7101     * @return The icon for the bubble
7102     *
7103     * This function gets the icon shown on the top left of bubble.
7104     */
7105    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7106    /**
7107     * Unset the icon of the bubble
7108     *
7109     * Unparent and return the icon object which was set for this widget.
7110     *
7111     * @param obj The bubble object
7112     * @return The icon that was being used
7113     */
7114    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7115    /**
7116     * Set the corner of the bubble
7117     *
7118     * @param obj The bubble object.
7119     * @param corner The given corner for the bubble.
7120     *
7121     * This function sets the corner of the bubble. The corner will be used to
7122     * determine where the arrow in the frame points to and where label, icon and
7123     * info arre shown.
7124     *
7125     * Possible values for corner are:
7126     * @li "top_left" - Default
7127     * @li "top_right"
7128     * @li "bottom_left"
7129     * @li "bottom_right"
7130     */
7131    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
7132    /**
7133     * Get the corner of the bubble
7134     *
7135     * @param obj The bubble object.
7136     * @return The given corner for the bubble.
7137     *
7138     * This function gets the selected corner of the bubble.
7139     */
7140    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7141
7142    EINA_DEPRECATED EAPI void         elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
7143    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7144
7145    /**
7146     * @}
7147     */
7148
7149    /* photo */
7150    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7151    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
7152    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
7153    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
7154    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
7155    /* smart callbacks called:
7156     * "clicked" - the user clicked the icon
7157     * "drag,start" - Someone started dragging the image out of the object
7158     * "drag,end" - Dragged item was dropped (somewhere)
7159     */
7160
7161    /* gesture layer */
7162    /** @defgroup Elm_Gesture_Layer Gesture Layer */
7163    /**
7164     * @enum _Elm_Gesture_Types
7165     * Emum of supported gesture types.
7166     * @ingroup Elm_Gesture_Layer
7167     */
7168    enum _Elm_Gesture_Types
7169      {
7170         ELM_GESTURE_FIRST = 0,
7171
7172         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
7173         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
7174         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
7175         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
7176
7177         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
7178
7179         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
7180         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
7181
7182         ELM_GESTURE_ZOOM, /**< Zoom */
7183         ELM_GESTURE_ROTATE, /**< Rotate */
7184
7185         ELM_GESTURE_LAST
7186      };
7187
7188    /**
7189     * @typedef Elm_Gesture_Types
7190     * Type for Emum of supported gesture types.
7191     * @ingroup Elm_Gesture_Layer
7192     */
7193    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
7194
7195    /**
7196     * @enum _Elm_Gesture_State
7197     * Emum of gesture states.
7198     * @ingroup Elm_Gesture_Layer
7199     */
7200    enum _Elm_Gesture_State
7201      {
7202         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
7203         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
7204         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
7205         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
7206         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
7207      };
7208    /**
7209     * @typedef Elm_Gesture_State
7210     * gesture states.
7211     * @ingroup Elm_Gesture_Layer
7212     */
7213    typedef enum _Elm_Gesture_State Elm_Gesture_State;
7214
7215    /**
7216     * @struct _Elm_Gesture_Taps_Info
7217     * Struct holds taps info for user
7218     * @ingroup Elm_Gesture_Layer
7219     */
7220    struct _Elm_Gesture_Taps_Info
7221      {
7222         Evas_Coord x, y;         /**< Holds center point between fingers */
7223         unsigned int n;          /**< Number of fingers tapped           */
7224         unsigned int timestamp;  /**< event timestamp       */
7225      };
7226
7227    /**
7228     * @typedef Elm_Gesture_Taps_Info
7229     * holds taps info for user
7230     * @ingroup Elm_Gesture_Layer
7231     */
7232    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
7233
7234    /**
7235     * @struct _Elm_Gesture_Momentum_Info
7236     * Struct holds momentum info for user
7237     * x1 and y1 are not necessarily in sync
7238     * x1 holds x value of x direction starting point
7239     * and same holds for y1.
7240     * This is noticeable when doing V-shape movement
7241     * @ingroup Elm_Gesture_Layer
7242     */
7243    struct _Elm_Gesture_Momentum_Info
7244      {  /* Report line ends, timestamps, and momentum computed        */
7245         Evas_Coord x1; /**< Final-swipe direction starting point on X */
7246         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
7247         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
7248         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
7249
7250         unsigned int tx; /**< Timestamp of start of final x-swipe */
7251         unsigned int ty; /**< Timestamp of start of final y-swipe */
7252
7253         Evas_Coord mx; /**< Momentum on X */
7254         Evas_Coord my; /**< Momentum on Y */
7255
7256         unsigned int n;  /**< Number of fingers */
7257      };
7258
7259    /**
7260     * @typedef Elm_Gesture_Momentum_Info
7261     * holds momentum info for user
7262     * @ingroup Elm_Gesture_Layer
7263     */
7264     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
7265
7266    /**
7267     * @struct _Elm_Gesture_Line_Info
7268     * Struct holds line info for user
7269     * @ingroup Elm_Gesture_Layer
7270     */
7271    struct _Elm_Gesture_Line_Info
7272      {  /* Report line ends, timestamps, and momentum computed      */
7273         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
7274         /* FIXME should be radians, bot degrees */
7275         double angle;              /**< Angle (direction) of lines  */
7276      };
7277
7278    /**
7279     * @typedef _Elm_Gesture_Line_Info
7280     * Holds line info for user
7281     * @ingroup Elm_Gesture_Layer
7282     */
7283     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
7284
7285    /**
7286     * @struct _Elm_Gesture_Zoom_Info
7287     * Struct holds zoom info for user
7288     * @ingroup Elm_Gesture_Layer
7289     */
7290    struct _Elm_Gesture_Zoom_Info
7291      {
7292         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
7293         Evas_Coord radius; /**< Holds radius between fingers reported to user */
7294         double zoom;            /**< Zoom value: 1.0 means no zoom             */
7295         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
7296      };
7297
7298    /**
7299     * @typedef Elm_Gesture_Zoom_Info
7300     * Holds zoom info for user
7301     * @ingroup Elm_Gesture_Layer
7302     */
7303    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
7304
7305    /**
7306     * @struct _Elm_Gesture_Rotate_Info
7307     * Struct holds rotation info for user
7308     * @ingroup Elm_Gesture_Layer
7309     */
7310    struct _Elm_Gesture_Rotate_Info
7311      {
7312         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
7313         Evas_Coord radius; /**< Holds radius between fingers reported to user */
7314         double base_angle; /**< Holds start-angle */
7315         double angle;      /**< Rotation value: 0.0 means no rotation         */
7316         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
7317      };
7318
7319    /**
7320     * @typedef Elm_Gesture_Rotate_Info
7321     * Holds rotation info for user
7322     * @ingroup Elm_Gesture_Layer
7323     */
7324    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
7325
7326    /**
7327     * @typedef Elm_Gesture_Event_Cb
7328     * User callback used to stream gesture info from gesture layer
7329     * @param data user data
7330     * @param event_info gesture report info
7331     * Returns a flag field to be applied on the causing event.
7332     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
7333     * upon the event, in an irreversible way.
7334     *
7335     * @ingroup Elm_Gesture_Layer
7336     */
7337    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
7338
7339    /**
7340     * Use function to set callbacks to be notified about
7341     * change of state of gesture.
7342     * When a user registers a callback with this function
7343     * this means this gesture has to be tested.
7344     *
7345     * When ALL callbacks for a gesture are set to NULL
7346     * it means user isn't interested in gesture-state
7347     * and it will not be tested.
7348     *
7349     * @param obj Pointer to gesture-layer.
7350     * @param idx The gesture you would like to track its state.
7351     * @param cb callback function pointer.
7352     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
7353     * @param data user info to be sent to callback (usually, Smart Data)
7354     *
7355     * @ingroup Elm_Gesture_Layer
7356     */
7357    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);
7358
7359    /**
7360     * Call this function to get repeat-events settings.
7361     *
7362     * @param obj Pointer to gesture-layer.
7363     *
7364     * @return repeat events settings.
7365     * @see elm_gesture_layer_hold_events_set()
7366     * @ingroup Elm_Gesture_Layer
7367     */
7368    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7369
7370    /**
7371     * This function called in order to make gesture-layer repeat events.
7372     * Set this of you like to get the raw events only if gestures were not detected.
7373     * Clear this if you like gesture layer to fwd events as testing gestures.
7374     *
7375     * @param obj Pointer to gesture-layer.
7376     * @param r Repeat: TRUE/FALSE
7377     *
7378     * @ingroup Elm_Gesture_Layer
7379     */
7380    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
7381
7382    /**
7383     * This function sets step-value for zoom action.
7384     * Set step to any positive value.
7385     * Cancel step setting by setting to 0.0
7386     *
7387     * @param obj Pointer to gesture-layer.
7388     * @param s new zoom step value.
7389     *
7390     * @ingroup Elm_Gesture_Layer
7391     */
7392    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
7393
7394    /**
7395     * This function sets step-value for rotate action.
7396     * Set step to any positive value.
7397     * Cancel step setting by setting to 0.0
7398     *
7399     * @param obj Pointer to gesture-layer.
7400     * @param s new roatate step value.
7401     *
7402     * @ingroup Elm_Gesture_Layer
7403     */
7404    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
7405
7406    /**
7407     * This function called to attach gesture-layer to an Evas_Object.
7408     * @param obj Pointer to gesture-layer.
7409     * @param t Pointer to underlying object (AKA Target)
7410     *
7411     * @return TRUE, FALSE on success, failure.
7412     *
7413     * @ingroup Elm_Gesture_Layer
7414     */
7415    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
7416
7417    /**
7418     * Call this function to construct a new gesture-layer object.
7419     * This does not activate the gesture layer. You have to
7420     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
7421     *
7422     * @param parent the parent object.
7423     *
7424     * @return Pointer to new gesture-layer object.
7425     *
7426     * @ingroup Elm_Gesture_Layer
7427     */
7428    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7429
7430    /* thumb */
7431    typedef enum _Elm_Thumb_Animation_Setting
7432      {
7433         ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
7434         ELM_THUMB_ANIMATION_LOOP,      /* Keep playing animation until stop is requested */
7435         ELM_THUMB_ANIMATION_STOP,
7436         ELM_THUMB_ANIMATION_LAST
7437      } Elm_Thumb_Animation_Setting;
7438
7439    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7440    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
7441    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
7442    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
7443    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
7444    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
7445    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7446    EAPI void                        *elm_thumb_ethumb_client_get(void);
7447    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
7448    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7449    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7450    /* available styles:
7451     * default
7452     * noframe
7453     */
7454    /* smart callbacks called:
7455     * "clicked" - This is called when a user has clicked the thumb without dragging around.
7456     * "clicked,double" - This is called when a user has double-clicked the thumb.
7457     * "press" - This is called when a user has pressed down the thumb.
7458     * "generate,start" - The thumbnail generation started.
7459     * "generate,stop" - The generation process stopped.
7460     * "generate,error" - The generation failed.
7461     * "load,error" - The thumbnail image loading failed.
7462     */
7463
7464    /* hoversel */
7465    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7466    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7467    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7468    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7469    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7470    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7471    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7472    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7473    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7474    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7475    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
7476    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
7477    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7478    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7479    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7480    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);
7481    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
7482    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7483    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
7484    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
7485    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);
7486    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);
7487    /* smart callbacks called:
7488     * "clicked" - the user clicked the hoversel button and popped up the sel
7489     * "selected" - an item in the hoversel list is selected
7490     * "dismissed" - the hover is dismissed
7491     */
7492
7493    /* toolbar */
7494    typedef enum _Elm_Toolbar_Shrink_Mode
7495      {
7496         ELM_TOOLBAR_SHRINK_NONE,   /**< set toolbar minimun size to fit all the items */
7497         ELM_TOOLBAR_SHRINK_HIDE,   /**< hide excess items */
7498         ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
7499         ELM_TOOLBAR_SHRINK_MENU    /**< inserts a button to pop up a menu with excess items */
7500      } Elm_Toolbar_Shrink_Mode;
7501
7502    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
7503    typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
7504
7505    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7506    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
7507    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7508    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
7509    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7510    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
7511    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7512    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);
7513    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);
7514    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);
7515    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);
7516    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7517    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7518    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7519    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7520    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7521    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
7522    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7523    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7524    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7525    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
7526    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7527    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
7528    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7529    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7530    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7531    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7532    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
7533    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7534    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7535    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7536    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7537    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
7538    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7539    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
7540    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7541    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7542    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7543    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7544    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7545    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7546    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7547    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
7548    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7549    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
7550    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7551    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);
7552    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
7553    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
7554    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
7555    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
7556    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
7557    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
7558    EAPI void                    elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
7559    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);
7560    EAPI void                    elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7561    EAPI void                    elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
7562    EAPI const char             *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7563    EAPI void                    elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7564    EAPI const char             *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7565    EAPI void                    elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7566    EAPI void                    elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
7567    EAPI const char             *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7568    EAPI void                    elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7569    EAPI Eina_Bool               elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
7570    /* smart callbacks called:
7571     * "clicked" - when the user clicks on a toolbar item and becomes selected
7572     */
7573    /* available styles:
7574     * default
7575     * transparent (no background or shadow, just show the provided content)
7576     */
7577
7578    /* tooltip */
7579    EAPI double       elm_tooltip_delay_get(void);
7580    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
7581    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
7582    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
7583    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
7584    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);
7585    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7586    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
7587    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7588    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
7589    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7590    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7591    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
7592    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7593    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7594    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7595
7596    /* cursors */
7597    EAPI int          elm_cursor_engine_only_get(void);
7598    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
7599
7600    /* menu */
7601    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
7602    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7603    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
7604    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7605    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
7606    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
7607    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7608    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
7609    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);
7610    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
7611    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7612    EAPI void               elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
7613    EAPI const char        *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7614    EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7615    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7616    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7617    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7618    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7619    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
7620    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7621    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7622    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7623    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
7624    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
7625    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
7626    EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
7627    EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
7628    EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
7629    EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
7630    EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
7631
7632    /* smart callbacks called:
7633     * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
7634     */
7635
7636    /* list */
7637    typedef enum _Elm_List_Mode
7638      {
7639         ELM_LIST_COMPRESS = 0,
7640         ELM_LIST_SCROLL,
7641         ELM_LIST_LIMIT,
7642         ELM_LIST_EXPAND,
7643         ELM_LIST_LAST
7644      } Elm_List_Mode;
7645    typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
7646    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7647    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);
7648    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);
7649    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);
7650    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);
7651    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);
7652    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7653    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
7654    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
7655    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7656    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
7657    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7658    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7659    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7660    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
7661    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7662    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7663    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7664    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7665    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
7666    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
7667    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7668    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7669    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
7670    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
7671    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
7672    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7673    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7674    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7675    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7676    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7677    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
7678    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7679    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7680    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
7681    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
7682    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
7683    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
7684    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);
7685    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
7686    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
7687    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7688    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7689    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7690    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
7691    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
7692    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7693    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7694    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
7695    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7696    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
7697    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7698    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7699    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7700    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);
7701    /* smart callbacks called:
7702     * "clicked,double" - when the user double-clicked an item
7703     * "selected" - when the user selected an item
7704     * "unselected" - when the user selected an item
7705     * "longpressed" - an item in the hoversel list is long-pressed
7706     * "scroll,edge,top" - the list is scrolled until the top edge
7707     * "scroll,edge,bottom" - the list is scrolled until the bottom edge
7708     * "scroll,edge,left" - the list is scrolled until the left edge
7709     * "scroll,edge,right" - the list is scrolled until the right edge
7710     */
7711
7712    /* slider */
7713    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7714    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7715    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7716    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7717    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7718    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7719    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
7720    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7721    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7722    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
7723    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7724    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
7725    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7726    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
7727    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7728   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);
7729   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);
7730    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7731    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7732    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
7733    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
7734    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
7735    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7736    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
7737    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7738    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
7739    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7740    /* smart callbacks called:
7741     * "changed" - Whenever the slider value is changed by the user.
7742     * "slider,drag,start" - dragging the slider indicator around has started
7743     * "slider,drag,stop" - dragging the slider indicator around has stopped
7744     * "delay,changed" - A short time after the value is changed by the user.
7745     *                   This will be called only when the user stops dragging for a very short
7746     *                   period or when they release their finger/mouse, so it avoids possibly
7747     *                   expensive reactions to the value change.
7748     */
7749
7750
7751    /* actionslider */
7752
7753    /**
7754     * @addtogroup Actionslider Actionslider
7755     *
7756     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
7757     * properties. The indicator is the element the user drags to choose a label.
7758     * When the position is set with magnet, when released the indicator will be
7759     * moved to it if it's nearest the magnetized position.
7760     *
7761     * @note By default all positions are set as enabled.
7762     *
7763     * Signals that you can add callbacks for are:
7764     *
7765     * "selected" - when user selects an enabled position (the label is passed
7766     *              as event info)".
7767     * @n
7768     * "pos_changed" - when the indicator reaches any of the positions("left",
7769     *                 "right" or "center").
7770     *
7771     * See an example of actionslider usage @ref actionslider_example_page "here"
7772     * @{
7773     */
7774
7775    typedef enum _Elm_Actionslider_Indicator_Pos
7776      {
7777         ELM_ACTIONSLIDER_INDICATOR_NONE,
7778         ELM_ACTIONSLIDER_INDICATOR_LEFT,
7779         ELM_ACTIONSLIDER_INDICATOR_RIGHT,
7780         ELM_ACTIONSLIDER_INDICATOR_CENTER
7781      } Elm_Actionslider_Indicator_Pos;
7782
7783    typedef enum _Elm_Actionslider_Magnet_Pos
7784      {
7785         ELM_ACTIONSLIDER_MAGNET_NONE = 0,
7786         ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
7787         ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
7788         ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
7789         ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
7790         ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
7791      } Elm_Actionslider_Magnet_Pos;
7792
7793    typedef enum _Elm_Actionslider_Label_Pos
7794      {
7795         ELM_ACTIONSLIDER_LABEL_LEFT,
7796         ELM_ACTIONSLIDER_LABEL_RIGHT,
7797         ELM_ACTIONSLIDER_LABEL_CENTER,
7798         ELM_ACTIONSLIDER_LABEL_BUTTON
7799      } Elm_Actionslider_Label_Pos;
7800
7801    /* smart callbacks called:
7802     * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
7803     */
7804
7805    /**
7806     * Add a new actionslider to the parent.
7807     *
7808     * @param parent The parent object
7809     * @return The new actionslider object or NULL if it cannot be created
7810     */
7811    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7812
7813    /**
7814    * Set actionslider label.
7815    *
7816    * @param[in] obj The actionslider object
7817    * @param[in] pos The position of the label.
7818    * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
7819    * @param label The label which is going to be set.
7820    */
7821    EAPI void               elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
7822    /**
7823     * Get actionslider labels.
7824     *
7825     * @param obj The actionslider object
7826     * @param left_label A char** to place the left_label of @p obj into.
7827     * @param center_label A char** to place the center_label of @p obj into.
7828     * @param right_label A char** to place the right_label of @p obj into.
7829     */
7830    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);
7831    /**
7832     * Get actionslider selected label.
7833     *
7834     * @param obj The actionslider object
7835     * @return The selected label
7836     */
7837    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7838    /**
7839     * Set actionslider indicator position.
7840     *
7841     * @param obj The actionslider object.
7842     * @param pos The position of the indicator.
7843     */
7844    EAPI void                elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
7845    /**
7846     * Get actionslider indicator position.
7847     *
7848     * @param obj The actionslider object.
7849     * @return The position of the indicator.
7850     */
7851    EAPI Elm_Actionslider_Indicator_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7852    /**
7853     * Set actionslider magnet position. To make multiple positions magnets @c or
7854     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
7855     *
7856     * @param obj The actionslider object.
7857     * @param pos Bit mask indicating the magnet positions.
7858     */
7859    EAPI void                elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
7860    /**
7861     * Get actionslider magnet position.
7862     *
7863     * @param obj The actionslider object.
7864     * @return The positions with magnet property.
7865     */
7866    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7867    /**
7868     * Set actionslider enabled position. To set multiple positions as enabled @c or
7869     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
7870     *
7871     * @note All the positions are enabled by default.
7872     *
7873     * @param obj The actionslider object.
7874     * @param pos Bit mask indicating the enabled positions.
7875     */
7876    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
7877    /**
7878     * Get actionslider enabled position.
7879     *
7880     * @param obj The actionslider object.
7881     * @return The enabled positions.
7882     */
7883    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7884    /**
7885     * Set the label used on the indicator.
7886     *
7887     * @param obj The actionslider object
7888     * @param label The label to be set on the indicator.
7889     * @deprecated use elm_object_text_set() instead.
7890     */
7891    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7892    /**
7893     * Get the label used on the indicator object.
7894     *
7895     * @param obj The actionslider object
7896     * @return The indicator label
7897     * @deprecated use elm_object_text_get() instead.
7898     */
7899    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7900
7901    /**
7902    * Hold actionslider object movement.
7903    *
7904    * @param[in] obj The actionslider object
7905    * @param[in] flag Actionslider hold/release
7906    * (EINA_TURE = hold/EIN_FALSE = release)
7907    *
7908    * @ingroup Actionslider
7909    */
7910    EAPI void                             elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
7911
7912
7913    /**
7914     *
7915     */
7916
7917    /* genlist */
7918    typedef enum _Elm_Genlist_Item_Flags
7919      {
7920         ELM_GENLIST_ITEM_NONE = 0,
7921         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
7922         ELM_GENLIST_ITEM_GROUP = (1 << 1)
7923      } Elm_Genlist_Item_Flags;
7924    typedef enum _Elm_Genlist_Item_Field_Flags
7925      {
7926         ELM_GENLIST_ITEM_FIELD_ALL = 0,
7927         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
7928         ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
7929         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
7930      } Elm_Genlist_Item_Field_Flags;
7931    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
7932    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
7933    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
7934    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
7935    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
7936    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
7937    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
7938    typedef void         (*GenlistItemMovedFunc)    ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
7939
7940    struct _Elm_Genlist_Item_Class
7941      {
7942         const char                *item_style;
7943         struct {
7944           GenlistItemLabelGetFunc  label_get;
7945           GenlistItemIconGetFunc   icon_get;
7946           GenlistItemStateGetFunc  state_get;
7947           GenlistItemDelFunc       del;
7948           GenlistItemMovedFunc     moved;
7949         } func;
7950         const char *edit_item_style;
7951         const char                *mode_item_style;
7952      };
7953    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7954    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7955    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
7956    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7957    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
7958    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7959    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
7960    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7961    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
7962    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7963    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
7964    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7965    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
7966    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7967    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7968    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7969    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7970    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7971    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
7972    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7973    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
7974    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7975    /* operations to add items */
7976    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);
7977    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);
7978    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);
7979    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);
7980    /* operations to retrieve existing items */
7981    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7982    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7983    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7984    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);
7985    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7986    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7987    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7988    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);
7989    /* available item styles:
7990     * default
7991     * default_style - The text part is a textblock
7992     * double_label
7993     * icon_top_text_bottom
7994     */
7995    /* Genlist Item operation */
7996    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7997    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7998    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
7999    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
8000    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8001    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8002    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8003    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
8004    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8005    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
8006    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8007    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8008    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
8009    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
8010    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8011    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8012    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8013    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8014    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
8015    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
8016    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8017    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8018    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
8019    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
8020    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
8021    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8022    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
8023    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
8024    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
8025    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
8026    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);
8027    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8028    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
8029    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8030    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8031    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8032    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8033    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
8034    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8035    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8036    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8037    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
8038    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
8039    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8040    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8041    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8042    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8043    /* Signals that you can add callbacks for are:
8044     * "clicked,double" - This is called when a user has double-clicked an item.
8045     *                    The event_info parameter is the genlist item that was
8046     *                    double-clicked.
8047     * "selected" - This is called when a user has made an item selected. The
8048     *              event_info parameter is the genlist item that was selected.
8049     * "unselected" - This is called when a user has made an item unselected. The
8050     *                 event_info parameter is the genlist item that was unselected.
8051     * "expanded" - This is called when elm_genlist_item_expanded_set() is called
8052     *              and the item is now meant to be expanded. The event_info parameter is the
8053     *              genlist item that was indicated to expand. It is the job of this callback
8054     *              to then fill in the child items.
8055     * "contracted" - This is called when elm_genlist_item_expanded_set() is called
8056     *                and the item is now meant to be contracted. The event_info parameter is
8057     *                the genlist item that was indicated to contract. It is the job of this
8058     *                callback to then delete the child items.
8059     * "expand,request" - This is called when a user has indicated they want to
8060     *                    expand a tree branch item. The callback should decide if the item can
8061     *                    expand (has any children) and then call elm_genlist_item_expanded_set()
8062     *                    appropriately to set the state. The event_info parameter is the genlist
8063     *                    item that was indicated to expand.
8064     * "contract,request" - This is called when a user has indicated they want to
8065     *                      contract a tree branch item. The callback should decide if the item can
8066     *                      contract (has any children) and then call elm_genlist_item_expanded_set()
8067     *                      appropriately to set the state. The event_info parameter is the genlist
8068     *                      item that was indicated to contract.
8069     * "realized" - This is called when the item in the list is created as a real
8070     *              evas object. event_info parameter is the genlist item that was created.
8071     *              The object may be deleted at any time, so it is up to the caller to
8072     *              not use the object pointer from elm_genlist_item_object_get() in a way
8073     *              where it may point to freed objects.
8074     * "unrealized" - This is called just before an item is unrealized. After
8075     *                this call icon objects provided will be deleted and the item object
8076     *                itself delete or be put into a floating cache.
8077     * "drag,start,up" - This is called when the item in the list has been dragged
8078     *                   (not scrolled) up.
8079     * "drag,start,down" - This is called when the item in the list has been dragged
8080     *                     (not scrolled) down.
8081     * "drag,start,left" - This is called when the item in the list has been dragged i
8082     *                     (not scrolled) left.
8083     * "drag,start,right" - This is called when the item in the list has been dragged
8084     *                      (not scrolled) right.
8085     * "drag,stop" - This is called when the item in the list has stopped being
8086     *               dragged.
8087     * "drag" - This is called when the item in the list is being dragged.
8088     * "longpressed" - This is called when the item is pressed for a certain amount
8089     *                 of time. By default it's 1 second.
8090     * "scroll,anim,start" - This is called when scrolling animation has started.
8091     * "scroll,anim,stop" - This is called when scrolling animation has stopped.
8092     * "scroll,drag,start" - This is called when dragging the content has started.
8093     * "scroll,drag,stop" - This is called when dragging the content has stopped.
8094     * "scroll,edge,top" - This is called when the genlist is scrolled until the
8095     *                     top edge.
8096     * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
8097     *                         bottom edge.
8098     * "scroll,edge,left" - This is called when the genlist is scrolled until the
8099     *                      left edge.
8100     * "scroll,edge,right" - This is called when the genlist is scrolled until the
8101     *                       right edge.
8102     * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
8103     *                       left.
8104     * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
8105     *                       right.
8106     * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
8107     * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
8108     *                      down.
8109     * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
8110     *                     out.
8111     * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
8112     */
8113
8114    EAPI void               elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
8115    EAPI Eina_Bool          elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8116    EAPI void               elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
8117    EAPI Eina_Bool          elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
8118    EAPI void               elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
8119    EAPI void               elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
8120    EAPI void               elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
8121    EAPI void               elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
8122    EAPI void               elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
8123    EAPI Eina_Bool          elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8124
8125    /**
8126     * @page tutorial_check Check example
8127     * @dontinclude check_example_01.c
8128     *
8129     * This example will show 2 checkboxes, one with just a label and the second
8130     * one with both a label and an icon. This example also ilustrates how to
8131     * have the checkbox change the value of a variable and how to react to those
8132     * changes.
8133     *
8134     * We will start with the usual setup code:
8135     * @until show(bg)
8136     *
8137     * And now we create our first checkbox, set its label, tell it to change
8138     * the value of @p value when the checkbox stats is changed and ask to be
8139     * notified of state changes:
8140     * @until show
8141     *
8142     * For our second checkbox we are going to set an icon so we need to create
8143     * and icon:
8144     * @until show
8145     * @note For simplicity we are using a rectangle as icon, but any evas object
8146     * can be used.
8147     *
8148     * And for our second checkbox we set the label, icon and state to true:
8149     * @until show
8150     *
8151     * We now do some more setup:
8152     * @until ELM_MAIN
8153     *
8154     * And finally implement the callback that will be called when the first
8155     * checkbox's state changes. This callback will use @p data to print a
8156     * message:
8157     * @until }
8158     * @note This work because @p data is @p value(from the main function) and @p
8159     * value is changed when the checkbox is changed.
8160     *
8161     * Our example will look like this:
8162     * @image html screenshots/check_example_01.png
8163     * @image latex screenshots/check_example_01.eps
8164     *
8165     * @example check_example_01.c
8166     */
8167    /**
8168     * @defgroup Check Check
8169     *
8170     * @brief The check widget allows for toggling a value between true and
8171     * false.
8172     *
8173     * Check objects are a lot like radio objects in layout and functionality
8174     * except they do not work as a group, but independently and only toggle the
8175     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
8176     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
8177     * returns the current state. For convenience, like the radio objects, you
8178     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
8179     * for it to modify.
8180     *
8181     * Signals that you can add callbacks for are:
8182     * "changed" - This is called whenever the user changes the state of one of
8183     *             the check object(event_info is NULL).
8184     *
8185     * @ref tutorial_check should give you a firm grasp of how to use this widget.
8186     * @{
8187     */
8188    /**
8189     * @brief Add a new Check object
8190     *
8191     * @param parent The parent object
8192     * @return The new object or NULL if it cannot be created
8193     */
8194    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8195    /**
8196     * @brief Set the text label of the check object
8197     *
8198     * @param obj The check object
8199     * @param label The text label string in UTF-8
8200     *
8201     * @deprecated use elm_object_text_set() instead.
8202     */
8203    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8204    /**
8205     * @brief Get the text label of the check object
8206     *
8207     * @param obj The check object
8208     * @return The text label string in UTF-8
8209     *
8210     * @deprecated use elm_object_text_get() instead.
8211     */
8212    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8213    /**
8214     * @brief Set the icon object of the check object
8215     *
8216     * @param obj The check object
8217     * @param icon The icon object
8218     *
8219     * Once the icon object is set, a previously set one will be deleted.
8220     * If you want to keep that old content object, use the
8221     * elm_check_icon_unset() function.
8222     */
8223    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8224    /**
8225     * @brief Get the icon object of the check object
8226     *
8227     * @param obj The check object
8228     * @return The icon object
8229     */
8230    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8231    /**
8232     * @brief Unset the icon used for the check object
8233     *
8234     * @param obj The check object
8235     * @return The icon object that was being used
8236     *
8237     * Unparent and return the icon object which was set for this widget.
8238     */
8239    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8240    /**
8241     * @brief Set the on/off state of the check object
8242     *
8243     * @param obj The check object
8244     * @param state The state to use (1 == on, 0 == off)
8245     *
8246     * This sets the state of the check. If set
8247     * with elm_check_state_pointer_set() the state of that variable is also
8248     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
8249     */
8250    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8251    /**
8252     * @brief Get the state of the check object
8253     *
8254     * @param obj The check object
8255     * @return The boolean state
8256     */
8257    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8258    /**
8259     * @brief Set a convenience pointer to a boolean to change
8260     *
8261     * @param obj The check object
8262     * @param statep Pointer to the boolean to modify
8263     *
8264     * This sets a pointer to a boolean, that, in addition to the check objects
8265     * state will also be modified directly. To stop setting the object pointed
8266     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
8267     * then when this is called, the check objects state will also be modified to
8268     * reflect the value of the boolean @p statep points to, just like calling
8269     * elm_check_state_set().
8270     */
8271    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
8272    /**
8273     * @}
8274     */
8275
8276    /* radio */
8277    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8278    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8279    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8280    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8281    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8282    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8283    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
8284    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
8285    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8286    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
8287    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8288    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
8289    /* smart callbacks called:
8290     * "changed" - when the radio status is changed
8291     */
8292
8293    /* pager */
8294    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8295    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8296    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
8297    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8298    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8299    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8300    EAPI void         elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
8301    EAPI void         elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
8302
8303    /* available item styles:
8304     * default
8305     * fade
8306     * fade_translucide
8307     * fade_invisible
8308     */
8309    /* smart callbacks called:
8310     * "hide,finished" - when the previous page is hided
8311     */
8312
8313    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
8314    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
8315    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
8316    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
8317    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
8318
8319    struct _Elm_Slideshow_Item_Class
8320      {
8321         struct _Elm_Slideshow_Item_Class_Func
8322           {
8323              SlideshowItemGetFunc get;
8324              SlideshowItemDelFunc del;
8325           } func;
8326      };
8327
8328    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8329    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
8330    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);
8331    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
8332    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8333    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
8334    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8335    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
8336    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8337    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
8338    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8339    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
8340    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8341    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8342    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8343    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
8344    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
8345    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8346    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
8347    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
8348    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8349    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
8350    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8351    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
8352    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8353    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
8354    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8355    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8356    /* smart callbacks called:
8357     * "changed" - when the slideshow switch to another item
8358     */
8359
8360    /* file selector */
8361    typedef enum _Elm_Fileselector_Mode
8362      {
8363         ELM_FILESELECTOR_LIST = 0,
8364         ELM_FILESELECTOR_GRID,
8365         ELM_FILESELECTOR_LAST
8366      } Elm_Fileselector_Mode;
8367
8368    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8369    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
8370    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8371    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
8372    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8373    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
8374    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8375    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8376    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
8377    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
8378    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8379    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8380    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
8381    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
8382    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8383    /* smart callbacks called:
8384     * "selected" - the user click on a file
8385     * "directory,open" - the list is populate with a new content. event_info is a directory.
8386     * "done" - the user click on the ok or cancel buttons
8387     */
8388
8389    /* progressbar */
8390    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8391    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
8392    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8393    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8394    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
8395    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8396    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8397    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8398    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8399    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8400    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8401    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
8402    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8403    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
8404    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8405    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
8406    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8407    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
8408    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8409    /* smart callbacks called:
8410     */
8411    /* available item styles:
8412     * default
8413     * wheel (simple style, no text, no progression, only pulse is available)
8414     */
8415
8416    /* separator */
8417    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8418    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
8419    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8420    /* smart callbacks called:
8421     */
8422
8423    /* spinner */
8424    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8425    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
8426    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8427    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
8428    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
8429    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
8430    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8431    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
8432    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8433    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
8434    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8435    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8436    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8437    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
8438    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
8439    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8440    /* smart callbacks called:
8441     * "changed" - when the spinner value changes
8442     * "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).
8443     */
8444    /* available item styles:
8445     * default
8446     * vertical (two up/down buttons at the right side and text left aligned)
8447     */
8448
8449    /* index */
8450    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
8451
8452    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8453    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
8454    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8455    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
8456    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8457    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
8458    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
8459    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
8460    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
8461    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
8462    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);
8463    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
8464    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
8465    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8466    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
8467    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
8468    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
8469    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
8470    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
8471    EAPI void            elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
8472    /* smart callbacks called:
8473     * "changed" - when the selected index item changes
8474     * "delay,changed" - when the selected index item changes, but after some small idle period
8475     * "selected" - when the user releases a finger and selects an item
8476     * "level,up" - when the user moves a finger from the first level to the second level
8477     * "level,down" - when the user moves a finger from the second level to the first level
8478     */
8479
8480    /* photocam */
8481    typedef enum _Elm_Photocam_Zoom_Mode
8482      {
8483         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
8484         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
8485         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
8486         ELM_PHOTOCAM_ZOOM_MODE_LAST
8487      } Elm_Photocam_Zoom_Mode;
8488
8489    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8490    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
8491    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8492    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
8493    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8494    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
8495    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8496    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
8497    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8498    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8499    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8500    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
8501    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8502    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8503    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8504    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8505    /* smart callbacks called:
8506     * "clicked" - when image clicked
8507     * "press" - when mouse/finger held down initially on image
8508     * "longpressed" - when mouse/finger held for long time on image
8509     * "clicked,double" - when mouse/finger double-clicked
8510     * "load" - when photo load begins
8511     * "loaded" - when photo load done
8512     * "load,detail" - when detailed image load begins
8513     * "loaded,detail" - when detailed image load done
8514     * "zoom,start" - when zooming started
8515     * "zoom,stop" - when zooming stopped
8516     * "zoom,change" - when auto zoom mode changed zoom level
8517     * "scroll - the content has been scrolled (moved)
8518     * "scroll,anim,start" - scrolling animation has started
8519     * "scroll,anim,stop" - scrolling animation has stopped
8520     * "scroll,drag,start" - dragging the contents around has started
8521     * "scroll,drag,stop" - dragging the contents around has stopped
8522     */
8523
8524    /* map */
8525    typedef enum _Elm_Map_Zoom_Mode
8526      {
8527         ELM_MAP_ZOOM_MODE_MANUAL,
8528         ELM_MAP_ZOOM_MODE_AUTO_FIT,
8529         ELM_MAP_ZOOM_MODE_AUTO_FILL,
8530         ELM_MAP_ZOOM_MODE_LAST
8531      } Elm_Map_Zoom_Mode;
8532
8533    typedef enum _Elm_Map_Route_Sources
8534      {
8535         ELM_MAP_ROUTE_SOURCE_YOURS,
8536         ELM_MAP_ROUTE_SOURCE_MONAV,
8537         ELM_MAP_ROUTE_SOURCE_ORS,
8538         ELM_MAP_ROUTE_SOURCE_LAST
8539      } Elm_Map_Route_Sources;
8540
8541    typedef enum _Elm_Map_Name_Sources
8542      {
8543         ELM_MAP_NAME_SOURCE_NOMINATIM,
8544         ELM_MAP_NAME_SOURCE_LAST
8545      } Elm_Map_Name_Sources;
8546
8547    typedef enum _Elm_Map_Route_Type
8548      {
8549         ELM_MAP_ROUTE_TYPE_MOTOCAR,
8550         ELM_MAP_ROUTE_TYPE_BICYCLE,
8551         ELM_MAP_ROUTE_TYPE_FOOT,
8552         ELM_MAP_ROUTE_TYPE_LAST
8553      } Elm_Map_Route_Type;
8554
8555    typedef enum _Elm_Map_Route_Method
8556      {
8557         ELM_MAP_ROUTE_METHOD_FASTEST,
8558         ELM_MAP_ROUTE_METHOD_SHORTEST,
8559         ELM_MAP_ROUTE_METHOD_LAST
8560      } Elm_Map_Route_Method;
8561
8562    typedef enum _Elm_Map_Name_Method
8563      {
8564         ELM_MAP_NAME_METHOD_SEARCH,
8565         ELM_MAP_NAME_METHOD_REVERSE,
8566         ELM_MAP_NAME_METHOD_LAST
8567      } Elm_Map_Name_Method;
8568
8569    typedef struct _Elm_Map_Marker          Elm_Map_Marker;
8570    typedef struct _Elm_Map_Marker_Class    Elm_Map_Marker_Class;
8571    typedef struct _Elm_Map_Group_Class     Elm_Map_Group_Class;
8572    typedef struct _Elm_Map_Route           Elm_Map_Route;
8573    typedef struct _Elm_Map_Name            Elm_Map_Name;
8574    typedef struct _Elm_Map_Track           Elm_Map_Track;
8575
8576    typedef Evas_Object *(*ElmMapMarkerGetFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
8577    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
8578    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
8579    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data);
8580
8581    typedef char        *(*ElmMapModuleSourceFunc) (void);
8582    typedef int          (*ElmMapModuleZoomMinFunc) (void);
8583    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
8584    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
8585    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
8586    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
8587    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
8588    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
8589    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
8590
8591    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8592    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
8593    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8594    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
8595    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8596    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
8597    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
8598    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
8599    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
8600    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8601    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
8602    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8603    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
8604    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);
8605    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);
8606    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
8607    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
8608    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);
8609    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);
8610    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
8611    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
8612    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
8613    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
8614    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
8615    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
8616    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
8617    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
8618    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
8619    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
8620    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
8621    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
8622    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
8623    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
8624    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
8625    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
8626    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
8627    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
8628    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
8629    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
8630    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
8631    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8632    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
8633    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8634    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
8635    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8636    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
8637    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8638    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
8639    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8640    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
8641    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8642    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);
8643    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
8644    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
8645    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
8646    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
8647    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
8648    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
8649    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
8650    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
8651    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
8652    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
8653    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);
8654    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8655    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8656 #ifdef ELM_EMAP
8657    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
8658 #endif
8659    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
8660
8661    /* smart callbacks called:
8662     * "clicked" - when image clicked
8663     * "press" - when mouse/finger held down initially on image
8664     * "longpressed" - when mouse/finger held for long time on image
8665     * "clicked,double" - when mouse/finger double-clicked
8666     * "load,details" - when detailed image load begins
8667     * "loaded,details" - when detailed image load done
8668     * "zoom,start" - when zooming started
8669     * "zoom,stop" - when zooming stopped
8670     * "zoom,change" - when auto zoom mode changed zoom level
8671     * "scroll - the content has been scrolled (moved)
8672     * "scroll,anim,start" - scrolling animation has started
8673     * "scroll,anim,stop" - scrolling animation has stopped
8674     * "scroll,drag,start" - dragging the contents around has started
8675     * "scroll,drag,stop" - dragging the contents around has stopped
8676     */
8677
8678    /* Route */
8679    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
8680 #ifdef ELM_EMAP
8681    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
8682 #endif
8683    EAPI double elm_route_lon_min_get(Evas_Object *obj);
8684    EAPI double elm_route_lat_min_get(Evas_Object *obj);
8685    EAPI double elm_route_lon_max_get(Evas_Object *obj);
8686    EAPI double elm_route_lat_max_get(Evas_Object *obj);
8687
8688
8689    /* panel */
8690    typedef enum _Elm_Panel_Orient
8691      {
8692         ELM_PANEL_ORIENT_TOP,
8693         ELM_PANEL_ORIENT_BOTTOM,
8694         ELM_PANEL_ORIENT_LEFT,
8695         ELM_PANEL_ORIENT_RIGHT,
8696      } Elm_Panel_Orient;
8697
8698    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8699    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
8700    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8701    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8702    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8703    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8704    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
8705    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8706    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
8707
8708    /* panes */
8709    /**
8710     * TODO
8711     *
8712     * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
8713     * Add events (move, start ...)
8714     */
8715    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8716    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8717    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8718    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8719    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8720    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8721    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8722    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8723    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
8724    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
8725    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8726    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
8727    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8728
8729    /* flip */
8730    typedef enum _Elm_Flip_Mode
8731      {
8732         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
8733         ELM_FLIP_ROTATE_X_CENTER_AXIS,
8734         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
8735         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
8736         ELM_FLIP_CUBE_LEFT,
8737         ELM_FLIP_CUBE_RIGHT,
8738         ELM_FLIP_CUBE_UP,
8739         ELM_FLIP_CUBE_DOWN,
8740         ELM_FLIP_PAGE_LEFT,
8741         ELM_FLIP_PAGE_RIGHT,
8742         ELM_FLIP_PAGE_UP,
8743         ELM_FLIP_PAGE_DOWN
8744      } Elm_Flip_Mode;
8745    typedef enum _Elm_Flip_Interaction
8746      {
8747         ELM_FLIP_INTERACTION_NONE,
8748         ELM_FLIP_INTERACTION_ROTATE,
8749         ELM_FLIP_INTERACTION_CUBE,
8750         ELM_FLIP_INTERACTION_PAGE
8751      } Elm_Flip_Interaction;
8752    typedef enum _Elm_Flip_Direction
8753      {
8754         ELM_FLIP_DIRECTION_UP,
8755         ELM_FLIP_DIRECTION_DOWN,
8756         ELM_FLIP_DIRECTION_LEFT,
8757         ELM_FLIP_DIRECTION_RIGHT
8758      } Elm_Flip_Direction;
8759
8760    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8761    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8762    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8763    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8764    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8765    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8766    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8767    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8768    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
8769    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
8770    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
8771    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
8772    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
8773    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
8774    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
8775    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
8776    /* smart callbacks called:
8777     * "animate,begin" - when a flip animation was started
8778     * "animate,done" - when a flip animation is finished
8779     */
8780
8781    /* scrolledentry */
8782    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8783    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8784    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8785    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8786    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8787    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8788    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8789    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8790    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8791    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8792    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8793    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8794    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8795    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8796    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8797    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8798    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8799    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8800    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8801    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8802    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8803    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8804    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8805    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8806    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8807    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8808    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8809    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8810    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8811    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8812    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8813    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8814    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8815    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8816    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8817    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);
8818    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8819    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8820    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);
8821    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8822    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);
8823    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
8824    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8825    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8826    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8827    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
8828    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8829    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8830    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8831    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);
8832    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);
8833    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);
8834    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);
8835    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);
8836    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);
8837    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
8838    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
8839    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
8840    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
8841    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8842    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
8843    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8844    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
8845    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
8846    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
8847    EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
8848    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
8849    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
8850
8851    /* conformant */
8852    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8853    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8854    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8855    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8856    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8857
8858    /* mapbuf */
8859    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8860    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8861    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8862    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8863    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
8864    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8865    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
8866    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8867    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
8868    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8869
8870    /**
8871     * @defgroup Flipselector Flip Selector
8872     *
8873     * A flip selector is a widget to show a set of @b text items, one
8874     * at a time, with the same sheet switching style as the @ref Clock
8875     * "clock" widget, when one changes the current displaying sheet
8876     * (thus, the "flip" in the name).
8877     *
8878     * User clicks to flip sheets which are @b held for some time will
8879     * make the flip selector to flip continuosly and automatically for
8880     * the user. The interval between flips will keep growing in time,
8881     * so that it helps the user to reach an item which is distant from
8882     * the current selection.
8883     *
8884     * Smart callbacks one can register to:
8885     * - @c "selected" - when the widget's selected text item is changed
8886     * - @c "overflowed" - when the widget's current selection is changed
8887     *   from the first item in its list to the last
8888     * - @c "underflowed" - when the widget's current selection is changed
8889     *   from the last item in its list to the first
8890     *
8891     * Available styles for it:
8892     * - @c "default"
8893     *
8894     * Here is an example on its usage:
8895     * @li @ref flipselector_example
8896     */
8897
8898    /**
8899     * @addtogroup Flipselector
8900     * @{
8901     */
8902
8903    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
8904
8905    /**
8906     * Add a new flip selector widget to the given parent Elementary
8907     * (container) widget
8908     *
8909     * @param parent The parent object
8910     * @return a new flip selector widget handle or @c NULL, on errors
8911     *
8912     * This function inserts a new flip selector widget on the canvas.
8913     *
8914     * @ingroup Flipselector
8915     */
8916    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8917
8918    /**
8919     * Programmatically select the next item of a flip selector widget
8920     *
8921     * @param obj The flipselector object
8922     *
8923     * @note The selection will be animated. Also, if it reaches the
8924     * end of its list of member items, it will continue with the first
8925     * one onwards.
8926     *
8927     * @ingroup Flipselector
8928     */
8929    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8930
8931    /**
8932     * Programmatically select the previous item of a flip selector
8933     * widget
8934     *
8935     * @param obj The flipselector object
8936     *
8937     * @note The selection will be animated.  Also, if it reaches the
8938     * beginning of its list of member items, it will continue with the
8939     * last one backwards.
8940     *
8941     * @ingroup Flipselector
8942     */
8943    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8944
8945    /**
8946     * Append a (text) item to a flip selector widget
8947     *
8948     * @param obj The flipselector object
8949     * @param label The (text) label of the new item
8950     * @param func Convenience callback function to take place when
8951     * item is selected
8952     * @param data Data passed to @p func, above
8953     * @return A handle to the item added or @c NULL, on errors
8954     *
8955     * The widget's list of labels to show will be appended with the
8956     * given value. If the user wishes so, a callback function pointer
8957     * can be passed, which will get called when this same item is
8958     * selected.
8959     *
8960     * @note The current selection @b won't be modified by appending an
8961     * element to the list.
8962     *
8963     * @note The maximum length of the text label is going to be
8964     * determined <b>by the widget's theme</b>. Strings larger than
8965     * that value are going to be @b truncated.
8966     *
8967     * @ingroup Flipselector
8968     */
8969    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
8970
8971    /**
8972     * Prepend a (text) item to a flip selector widget
8973     *
8974     * @param obj The flipselector object
8975     * @param label The (text) label of the new item
8976     * @param func Convenience callback function to take place when
8977     * item is selected
8978     * @param data Data passed to @p func, above
8979     * @return A handle to the item added or @c NULL, on errors
8980     *
8981     * The widget's list of labels to show will be prepended with the
8982     * given value. If the user wishes so, a callback function pointer
8983     * can be passed, which will get called when this same item is
8984     * selected.
8985     *
8986     * @note The current selection @b won't be modified by prepending
8987     * an element to the list.
8988     *
8989     * @note The maximum length of the text label is going to be
8990     * determined <b>by the widget's theme</b>. Strings larger than
8991     * that value are going to be @b truncated.
8992     *
8993     * @ingroup Flipselector
8994     */
8995    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
8996
8997    /**
8998     * Get the internal list of items in a given flip selector widget.
8999     *
9000     * @param obj The flipselector object
9001     * @return The list of items (#Elm_Flipselector_Item as data) or @c
9002     * NULL on errors.
9003     *
9004     * This list is @b not to be modified in any way and must not be
9005     * freed. Use the list members with functions like
9006     * elm_flipselector_item_label_set(),
9007     * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
9008     * elm_flipselector_item_del(),
9009     * elm_flipselector_item_selected_get(),
9010     * elm_flipselector_item_selected_set().
9011     *
9012     * @warning This list is only valid until @p obj object's internal
9013     * items list is changed. It should be fetched again with another
9014     * call to this function when changes happen.
9015     *
9016     * @ingroup Flipselector
9017     */
9018    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9019
9020    /**
9021     * Get the first item in the given flip selector widget's list of
9022     * items.
9023     *
9024     * @param obj The flipselector object
9025     * @return The first item or @c NULL, if it has no items (and on
9026     * errors)
9027     *
9028     * @see elm_flipselector_item_append()
9029     * @see elm_flipselector_last_item_get()
9030     *
9031     * @ingroup Flipselector
9032     */
9033    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9034
9035    /**
9036     * Get the last item in the given flip selector widget's list of
9037     * items.
9038     *
9039     * @param obj The flipselector object
9040     * @return The last item or @c NULL, if it has no items (and on
9041     * errors)
9042     *
9043     * @see elm_flipselector_item_prepend()
9044     * @see elm_flipselector_first_item_get()
9045     *
9046     * @ingroup Flipselector
9047     */
9048    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9049
9050    /**
9051     * Get the currently selected item in a flip selector widget.
9052     *
9053     * @param obj The flipselector object
9054     * @return The selected item or @c NULL, if the widget has no items
9055     * (and on erros)
9056     *
9057     * @ingroup Flipselector
9058     */
9059    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9060
9061    /**
9062     * Set whether a given flip selector widget's item should be the
9063     * currently selected one.
9064     *
9065     * @param item The flip selector item
9066     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
9067     *
9068     * This sets whether @p item is or not the selected (thus, under
9069     * display) one. If @p item is different than one under display,
9070     * the latter will be unselected. If the @p item is set to be
9071     * unselected, on the other hand, the @b first item in the widget's
9072     * internal members list will be the new selected one.
9073     *
9074     * @see elm_flipselector_item_selected_get()
9075     *
9076     * @ingroup Flipselector
9077     */
9078    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9079
9080    /**
9081     * Get whether a given flip selector widget's item is the currently
9082     * selected one.
9083     *
9084     * @param item The flip selector item
9085     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9086     * (or on errors).
9087     *
9088     * @see elm_flipselector_item_selected_set()
9089     *
9090     * @ingroup Flipselector
9091     */
9092    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
9093
9094    /**
9095     * Delete a given item from a flip selector widget.
9096     *
9097     * @param item The item to delete
9098     *
9099     * @ingroup Flipselector
9100     */
9101    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
9102
9103    /**
9104     * Get the label of a given flip selector widget's item.
9105     *
9106     * @param item The item to get label from
9107     * @return The text label of @p item or @c NULL, on errors
9108     *
9109     * @see elm_flipselector_item_label_set()
9110     *
9111     * @ingroup Flipselector
9112     */
9113    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
9114
9115    /**
9116     * Set the label of a given flip selector widget's item.
9117     *
9118     * @param item The item to set label on
9119     * @param label The text label string, in UTF-8 encoding
9120     *
9121     * @see elm_flipselector_item_label_get()
9122     *
9123     * @ingroup Flipselector
9124     */
9125    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
9126
9127    /**
9128     * Gets the item before @p item in a flip selector widget's
9129     * internal list of items.
9130     *
9131     * @param item The item to fetch previous from
9132     * @return The item before the @p item, in its parent's list. If
9133     *         there is no previous item for @p item or there's an
9134     *         error, @c NULL is returned.
9135     *
9136     * @see elm_flipselector_item_next_get()
9137     *
9138     * @ingroup Flipselector
9139     */
9140    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
9141
9142    /**
9143     * Gets the item after @p item in a flip selector widget's
9144     * internal list of items.
9145     *
9146     * @param item The item to fetch next from
9147     * @return The item after the @p item, in its parent's list. If
9148     *         there is no next item for @p item or there's an
9149     *         error, @c NULL is returned.
9150     *
9151     * @see elm_flipselector_item_next_get()
9152     *
9153     * @ingroup Flipselector
9154     */
9155    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
9156
9157    /**
9158     * Set the interval on time updates for an user mouse button hold
9159     * on a flip selector widget.
9160     *
9161     * @param obj The flip selector object
9162     * @param interval The (first) interval value in seconds
9163     *
9164     * This interval value is @b decreased while the user holds the
9165     * mouse pointer either flipping up or flipping doww a given flip
9166     * selector.
9167     *
9168     * This helps the user to get to a given item distant from the
9169     * current one easier/faster, as it will start to flip quicker and
9170     * quicker on mouse button holds.
9171     *
9172     * The calculation for the next flip interval value, starting from
9173     * the one set with this call, is the previous interval divided by
9174     * 1.05, so it decreases a little bit.
9175     *
9176     * The default starting interval value for automatic flips is
9177     * @b 0.85 seconds.
9178     *
9179     * @see elm_flipselector_interval_get()
9180     *
9181     * @ingroup Flipselector
9182     */
9183    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9184
9185    /**
9186     * Get the interval on time updates for an user mouse button hold
9187     * on a flip selector widget.
9188     *
9189     * @param obj The flip selector object
9190     * @return The (first) interval value, in seconds, set on it
9191     *
9192     * @see elm_flipselector_interval_set() for more details
9193     *
9194     * @ingroup Flipselector
9195     */
9196    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9197
9198    /**
9199     * @}
9200     */
9201
9202    /**
9203     * @addtogroup Animator Animator
9204     * @ingroup Elementary
9205     *
9206     * @brief Functions to ease creation of animations.
9207     *
9208     * elm_animator is designed to provide an easy way to create animations.
9209     * Creating an animation with elm_animator is as simple as setting a
9210     * duration, an operating callback and telling it to run the animation.
9211     * However that is not the full extent of elm_animator's ability, animations
9212     * can be paused and resumed, reversed and the animation need not be linear.
9213     *
9214     * To run an animation you must specify at least a duration and operation
9215     * callback, not setting any other properties will create a linear animation
9216     * that runs once and is not reversed.
9217     *
9218     * @ref elm_animator_example_page_01 "This" example should make all of that
9219     * very clear.
9220     *
9221     * @warning elm_animator is @b not a widget.
9222     * @{
9223     */
9224    /**
9225     * @brief Type of curve desired for animation.
9226     *
9227     * The speed in which an animation happens doesn't have to be linear, some
9228     * animations will look better if they're accelerating or decelerating, so
9229     * elm_animator provides four options in this regard:
9230     * @image html elm_animator_curve_style.png
9231     * @image latex elm_animator_curve_style.eps width=\textwidth
9232     * As can be seen in the image the speed of the animation will be:
9233     * @li ELM_ANIMATOR_CURVE_LINEAR constant
9234     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
9235     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
9236     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
9237     */
9238    typedef enum
9239      {
9240         ELM_ANIMATOR_CURVE_LINEAR,
9241         ELM_ANIMATOR_CURVE_IN_OUT,
9242         ELM_ANIMATOR_CURVE_IN,
9243         ELM_ANIMATOR_CURVE_OUT
9244      } Elm_Animator_Curve_Style;
9245    typedef struct _Elm_Animator Elm_Animator;
9246   /**
9247    * Called back per loop of an elementary animators cycle
9248    * @param data user-data given to elm_animator_operation_callback_set()
9249    * @param animator the animator being run
9250    * @param double the position in the animation
9251    */
9252    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
9253   /**
9254    * Called back when an elementary animator finishes
9255    * @param data user-data given to elm_animator_completion_callback_set()
9256    */
9257    typedef void (*Elm_Animator_Completion_Cb) (void *data);
9258
9259    /**
9260     * @brief Create a new animator.
9261     *
9262     * @param[in] parent Parent object
9263     *
9264     * The @a parent argument can be set to NULL for no parent. If a parent is set
9265     * there is no need to call elm_animator_del(), when the parent is deleted it
9266     * will delete the animator.
9267     * @deprecated Use @ref Transit instead.
9268
9269     */
9270    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
9271    /**
9272     * Deletes the animator freeing any resources it used. If the animator was
9273     * created with a NULL parent this must be called, otherwise it will be
9274     * automatically called when the parent is deleted.
9275     *
9276     * @param[in] animator Animator object
9277     * @deprecated Use @ref Transit instead.
9278     */
9279    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
9280    /**
9281     * Set the duration of the animation.
9282     *
9283     * @param[in] animator Animator object
9284     * @param[in] duration Duration in second
9285     * @deprecated Use @ref Transit instead.
9286     */
9287    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
9288    /**
9289     * @brief Set the callback function for animator operation.
9290     *
9291     * @param[in] animator Animator object
9292     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
9293     * @param[in] data Callback function user argument
9294     *
9295     * The @p func callback will be called with a frame value in range [0, 1] which
9296     * indicates how far along the animation should be. It is the job of @p func to
9297     * actually change the state of any object(or objects) that are being animated.
9298     * @deprecated Use @ref Transit instead.
9299     */
9300    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
9301    /**
9302     * Set the callback function for the when the animation ends.
9303     *
9304     * @param[in]  animator Animator object
9305     * @param[in]  func   Callback function pointe
9306     * @param[in]  data Callback function user argument
9307     *
9308     * @warning @a func will not be executed if elm_animator_stop() is called.
9309     * @deprecated Use @ref Transit instead.
9310     */
9311    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
9312    /**
9313     * @brief Stop animator.
9314     *
9315     * @param[in] animator Animator object
9316     *
9317     * If called before elm_animator_animate() it does nothing. If there is an
9318     * animation in progress the animation will be stopped(the operation callback
9319     * will not be executed again) and it can't be restarted using
9320     * elm_animator_resume().
9321     * @deprecated Use @ref Transit instead.
9322     */
9323    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
9324    /**
9325     * Set the animator repeat count.
9326     *
9327     * @param[in]  animator Animator object
9328     * @param[in]  repeat_cnt Repeat count
9329     * @deprecated Use @ref Transit instead.
9330     */
9331    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
9332    /**
9333     * @brief Start animation.
9334     *
9335     * @param[in] animator Animator object
9336     *
9337     * This function starts the animation if the nescessary properties(duration
9338     * and operation callback) have been set. Once started the animation will
9339     * run until complete or elm_animator_stop() is called.
9340     * @deprecated Use @ref Transit instead.
9341     */
9342    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
9343    /**
9344     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
9345     *
9346     * @param[in] animator Animator object
9347     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
9348     * @deprecated Use @ref Transit instead.
9349     */
9350    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
9351    /**
9352     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
9353     *
9354     * @param[in] animator Animator object
9355     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
9356     * @deprecated Use @ref Transit instead.
9357     */
9358    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
9359    /**
9360     * @brief Sets wether the animation should be automatically reversed.
9361     *
9362     * @param[in] animator Animator object
9363     * @param[in] reverse Reverse or not
9364     *
9365     * This controls wether the animation will be run on reverse imediately after
9366     * running forward. When this is set together with repetition the animation
9367     * will run in reverse once for each time it ran forward.@n
9368     * Runnin an animation in reverse is accomplished by calling the operation
9369     * callback with a frame value starting at 1 and diminshing until 0.
9370     * @deprecated Use @ref Transit instead.
9371     */
9372    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
9373    /**
9374     * Gets wether the animation will automatically reversed
9375     *
9376     * @param[in] animator Animator object
9377     * @deprecated Use @ref Transit instead.
9378     */
9379    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
9380    /**
9381     * Gets the status for the animator operation. The status of the animator @b
9382     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
9383     * only informs if the animation was started and has not ended(either normally
9384     * or through elm_animator_stop()).
9385     *
9386     * @param[in] animator Animator object
9387     * @deprecated Use @ref Transit instead.
9388     */
9389    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
9390    /**
9391     * Gets how many times the animation will be repeated
9392     *
9393     * @param[in] animator Animator object
9394     * @deprecated Use @ref Transit instead.
9395     */
9396    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
9397    /**
9398     * Pause the animator.
9399     *
9400     * @param[in]  animator Animator object
9401     *
9402     * This causes the animation to be temporarily stopped(the operation callback
9403     * will not be called). If the animation is not yet running this is a no-op.
9404     * Once an animation has been paused with this function it can be resumed
9405     * using elm_animator_resume().
9406     * @deprecated Use @ref Transit instead.
9407     */
9408    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
9409    /**
9410     * @brief Resumes the animator.
9411     *
9412     * @param[in]  animator Animator object
9413     *
9414     * Resumes an animation that was paused using elm_animator_pause(), after
9415     * calling this function calls to the operation callback will happen
9416     * normally. If an animation is stopped by means of elm_animator_stop it
9417     * @b can't be restarted with this function.@n
9418     *
9419     * @warning When an animation is resumed it doesn't start from where it was paused, it
9420     * will go to where it would have been if it had not been paused. If an
9421     * animation with a duration of 3 seconds is paused after 1 second for 1 second
9422     * it will resume as if it had ben animating for 2 seconds, the operating
9423     * callback will be called with a frame value of aproximately 2/3.
9424     * @deprecated Use @ref Transit instead.
9425     */
9426    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
9427    /**
9428     * @}
9429     */
9430
9431    /* calendar */
9432    typedef enum
9433      {
9434         ELM_CALENDAR_UNIQUE,
9435         ELM_CALENDAR_DAILY,
9436         ELM_CALENDAR_WEEKLY,
9437         ELM_CALENDAR_MONTHLY,
9438         ELM_CALENDAR_ANNUALLY
9439      } Elm_Calendar_Mark_Repeat;
9440    typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
9441
9442    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9443    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9444    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
9445    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9446    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9447    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
9448    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
9449    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9450    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
9451    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
9452    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
9453    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
9454    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);
9455    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
9456    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9457    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9458    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
9459    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
9460    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
9461    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
9462    /* smart callbacks called:
9463     * changed - emitted when the user select a day or change the displayed
9464     * month.
9465     */
9466
9467    /* diskselector */
9468    typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
9469
9470    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9471    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9472    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
9473    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9474    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
9475    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9476    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
9477    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9478    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9479    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);
9480    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
9481    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9482    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9483    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);
9484    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9485    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
9486    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9487    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9488    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
9489    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9490    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
9491    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9492    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9493    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9494    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9495    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9496    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9497    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9498    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
9499    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);
9500    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9501    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
9502    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9503    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9504    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9505    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9506    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
9507    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9508    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9509    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
9510    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
9511    /* smart callbacks called:
9512     * "selected" - when item is selected (scroller stops)
9513     */
9514
9515    /**
9516     * @page tutorial_colorselector Color selector example
9517     * @dontinclude colorselector_example_01.c
9518     *
9519     * This example shows how to change the color of a rectangle using a color
9520     * selector. We aren't going to explain a lot of the code since it's the
9521     * usual setup code:
9522     * @until show(rect)
9523     *
9524     * Now that we have a window with background and a rectangle we can create
9525     * our color_selector and set it's initial color to fully opaque blue:
9526     * @until show
9527     *
9528     * Next we tell ask to be notified whenever the color changes:
9529     * @until changed
9530     *
9531     * We follow that we some more run of the mill setup code:
9532     * @until ELM_MAIN()
9533     *
9534     * And now get to the callback that sets the color of the rectangle:
9535     * @until }
9536     *
9537     * This example will look like this:
9538     * @image html screenshots/colorselector_example_01.png
9539     * @image latex screenshots/colorselector_example_01.eps
9540     *
9541     * @example colorselector_example_01.c
9542     */
9543    /**
9544     * @defgroup Colorselector Colorselector
9545     *
9546     * @{
9547     *
9548     * @brief Widget for user to select a color.
9549     *
9550     * Signals that you can add callbacks for are:
9551     * "changed" - When the color value changes(event_info is NULL).
9552     *
9553     * See @ref tutorial_colorselector.
9554     */
9555    /**
9556     * @brief Add a new colorselector to the parent
9557     *
9558     * @param parent The parent object
9559     * @return The new object or NULL if it cannot be created
9560     *
9561     * @ingroup Colorselector
9562     */
9563    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9564    /**
9565     * Set a color for the colorselector
9566     *
9567     * @param obj   Colorselector object
9568     * @param r     r-value of color
9569     * @param g     g-value of color
9570     * @param b     b-value of color
9571     * @param a     a-value of color
9572     *
9573     * @ingroup Colorselector
9574     */
9575    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
9576    /**
9577     * Get a color from the colorselector
9578     *
9579     * @param obj   Colorselector object
9580     * @param r     integer pointer for r-value of color
9581     * @param g     integer pointer for g-value of color
9582     * @param b     integer pointer for b-value of color
9583     * @param a     integer pointer for a-value of color
9584     *
9585     * @ingroup Colorselector
9586     */
9587    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
9588    /**
9589     * @}
9590     */
9591
9592    /* Contextual Popup */
9593    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
9594
9595    typedef enum _Elm_Ctxpopup_Direction
9596      {
9597         ELM_CTXPOPUP_DIRECTION_DOWN,
9598         ELM_CTXPOPUP_DIRECTION_RIGHT,
9599         ELM_CTXPOPUP_DIRECTION_LEFT,
9600         ELM_CTXPOPUP_DIRECTION_UP,
9601         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
9602      } Elm_Ctxpopup_Direction;
9603
9604    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9605    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
9606    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
9607    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
9608    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
9609    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
9610    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9611    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9612    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
9613    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9614    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);
9615    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
9616    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9617    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
9618    EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
9619    EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9620    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);
9621    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);
9622    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9623    /* smart callbacks called:
9624     * "dismissed" - the ctxpopup was dismissed
9625     */
9626
9627    /* transit */
9628    /**
9629     *
9630     * @defgroup Transit Transit
9631     * @ingroup Elementary
9632     *
9633     * Transit is designed to apply various animated transition effects to @c
9634     * Evas_Object, such like translation, rotation, etc. For using these
9635     * effects, create an @ref Elm_Transit and add the desired transition effects.
9636     *
9637     * Once the effects are added into transit, they will be automatically
9638     * managed (their callback will be called until the duration is ended, and
9639     * they will be deleted on completion).
9640     *
9641     * Example:
9642     * @code
9643     * Elm_Transit *trans = elm_transit_add();
9644     * elm_transit_object_add(trans, obj);
9645     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
9646     * elm_transit_duration_set(transit, 1);
9647     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
9648     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
9649     * elm_transit_repeat_times_set(transit, 3);
9650     * @endcode
9651     *
9652     * Some transition effects are used to change the properties of objects. They
9653     * are:
9654     * @li @ref elm_transit_effect_translation_add
9655     * @li @ref elm_transit_effect_color_add
9656     * @li @ref elm_transit_effect_rotation_add
9657     * @li @ref elm_transit_effect_wipe_add
9658     * @li @ref elm_transit_effect_zoom_add
9659     * @li @ref elm_transit_effect_resizing_add
9660     *
9661     * Other transition effects are used to make one object disappear and another
9662     * object appear on its old place. These effects are:
9663     *
9664     * @li @ref elm_transit_effect_flip_add
9665     * @li @ref elm_transit_effect_resizable_flip_add
9666     * @li @ref elm_transit_effect_fade_add
9667     * @li @ref elm_transit_effect_blend_add
9668     *
9669     * It's also possible to make a transition chain with @ref
9670     * elm_transit_chain_transit_add.
9671     *
9672     * @warning We strongly recommend to use elm_transit just when edje can not do
9673     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
9674     * animations can be manipulated inside the theme.
9675     *
9676     * List of examples:
9677     * @li @ref transit_example_01_explained
9678     * @li @ref transit_example_02_explained
9679     * @li @ref transit_example_03_c
9680     * @li @ref transit_example_04_c
9681     *
9682     * @{
9683     */
9684
9685    /**
9686     * @enum Elm_Transit_Tween_Mode
9687     *
9688     * The type of acceleration used in the transition.
9689     */
9690    typedef enum
9691      {
9692         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
9693         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
9694                                              over time, then decrease again
9695                                              and stop slowly */
9696         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
9697                                              speed over time */
9698         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
9699                                             over time */
9700      } Elm_Transit_Tween_Mode;
9701
9702    /**
9703     * @enum Elm_Transit_Effect_Flip_Axis
9704     *
9705     * The axis where flip effect should be applied.
9706     */
9707    typedef enum
9708      {
9709         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
9710         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
9711      } Elm_Transit_Effect_Flip_Axis;
9712    /**
9713     * @enum Elm_Transit_Effect_Wipe_Dir
9714     *
9715     * The direction where the wipe effect should occur.
9716     */
9717    typedef enum
9718      {
9719         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
9720         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
9721         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
9722         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
9723      } Elm_Transit_Effect_Wipe_Dir;
9724    /** @enum Elm_Transit_Effect_Wipe_Type
9725     *
9726     * Whether the wipe effect should show or hide the object.
9727     */
9728    typedef enum
9729      {
9730         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
9731                                              animation */
9732         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
9733                                             animation */
9734      } Elm_Transit_Effect_Wipe_Type;
9735
9736    /**
9737     * @typedef Elm_Transit
9738     *
9739     * The Transit created with elm_transit_add(). This type has the information
9740     * about the objects which the transition will be applied, and the
9741     * transition effects that will be used. It also contains info about
9742     * duration, number of repetitions, auto-reverse, etc.
9743     */
9744    typedef struct _Elm_Transit Elm_Transit;
9745    typedef void Elm_Transit_Effect;
9746    /**
9747     * @typedef Elm_Transit_Effect_Transition_Cb
9748     *
9749     * Transition callback called for this effect on each transition iteration.
9750     */
9751    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
9752    /**
9753     * Elm_Transit_Effect_End_Cb
9754     *
9755     * Transition callback called for this effect when the transition is over.
9756     */
9757    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
9758
9759    /**
9760     * Elm_Transit_Del_Cb
9761     *
9762     * A callback called when the transit is deleted.
9763     */
9764    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
9765
9766    /**
9767     * Add new transit.
9768     *
9769     * @note Is not necessary to delete the transit object, it will be deleted at
9770     * the end of its operation.
9771     * @note The transit will start playing when the program enter in the main loop, is not
9772     * necessary to give a start to the transit.
9773     *
9774     * @return The transit object.
9775     *
9776     * @ingroup Transit
9777     */
9778    EAPI Elm_Transit                *elm_transit_add(void);
9779
9780    /**
9781     * Stops the animation and delete the @p transit object.
9782     *
9783     * Call this function if you wants to stop the animation before the duration
9784     * time. Make sure the @p transit object is still alive with
9785     * elm_transit_del_cb_set() function.
9786     * All added effects will be deleted, calling its repective data_free_cb
9787     * functions. The function setted by elm_transit_del_cb_set() will be called.
9788     *
9789     * @see elm_transit_del_cb_set()
9790     *
9791     * @param transit The transit object to be deleted.
9792     *
9793     * @ingroup Transit
9794     * @warning Just call this function if you are sure the transit is alive.
9795     */
9796    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
9797
9798    /**
9799     * Add a new effect to the transit.
9800     *
9801     * @note The cb function and the data are the key to the effect. If you try to
9802     * add an already added effect, nothing is done.
9803     * @note After the first addition of an effect in @p transit, if its
9804     * effect list become empty again, the @p transit will be killed by
9805     * elm_transit_del(transit) function.
9806     *
9807     * Exemple:
9808     * @code
9809     * Elm_Transit *transit = elm_transit_add();
9810     * elm_transit_effect_add(transit,
9811     *                        elm_transit_effect_blend_op,
9812     *                        elm_transit_effect_blend_context_new(),
9813     *                        elm_transit_effect_blend_context_free);
9814     * @endcode
9815     *
9816     * @param transit The transit object.
9817     * @param transition_cb The operation function. It is called when the
9818     * animation begins, it is the function that actually performs the animation.
9819     * It is called with the @p data, @p transit and the time progression of the
9820     * animation (a double value between 0.0 and 1.0).
9821     * @param effect The context data of the effect.
9822     * @param end_cb The function to free the context data, it will be called
9823     * at the end of the effect, it must finalize the animation and free the
9824     * @p data.
9825     *
9826     * @ingroup Transit
9827     * @warning The transit free the context data at the and of the transition with
9828     * the data_free_cb function, do not use the context data in another transit.
9829     */
9830    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);
9831
9832    /**
9833     * Delete an added effect.
9834     *
9835     * This function will remove the effect from the @p transit, calling the
9836     * data_free_cb to free the @p data.
9837     *
9838     * @see elm_transit_effect_add()
9839     *
9840     * @note If the effect is not found, nothing is done.
9841     * @note If the effect list become empty, this function will call
9842     * elm_transit_del(transit), that is, it will kill the @p transit.
9843     *
9844     * @param transit The transit object.
9845     * @param transition_cb The operation function.
9846     * @param effect The context data of the effect.
9847     *
9848     * @ingroup Transit
9849     */
9850    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);
9851
9852    /**
9853     * Add new object to apply the effects.
9854     *
9855     * @note After the first addition of an object in @p transit, if its
9856     * object list become empty again, the @p transit will be killed by
9857     * elm_transit_del(transit) function.
9858     * @note If the @p obj belongs to another transit, the @p obj will be
9859     * removed from it and it will only belong to the @p transit. If the old
9860     * transit stays without objects, it will die.
9861     * @note When you add an object into the @p transit, its state from
9862     * evas_object_pass_events_get(obj) is saved, and it is applied when the
9863     * transit ends, if you change this state whith evas_object_pass_events_set()
9864     * after add the object, this state will change again when @p transit stops to
9865     * run.
9866     *
9867     * @param transit The transit object.
9868     * @param obj Object to be animated.
9869     *
9870     * @ingroup Transit
9871     * @warning It is not allowed to add a new object after transit begins to go.
9872     */
9873    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
9874
9875    /**
9876     * Removes an added object from the transit.
9877     *
9878     * @note If the @p obj is not in the @p transit, nothing is done.
9879     * @note If the list become empty, this function will call
9880     * elm_transit_del(transit), that is, it will kill the @p transit.
9881     *
9882     * @param transit The transit object.
9883     * @param obj Object to be removed from @p transit.
9884     *
9885     * @ingroup Transit
9886     * @warning It is not allowed to remove objects after transit begins to go.
9887     */
9888    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
9889
9890    /**
9891     * Get the objects of the transit.
9892     *
9893     * @param transit The transit object.
9894     * @return a Eina_List with the objects from the transit.
9895     *
9896     * @ingroup Transit
9897     */
9898    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
9899
9900    /**
9901     * Enable/disable keeping up the objects states.
9902     * If it is not kept, the objects states will be reset when transition ends.
9903     *
9904     * @note @p transit can not be NULL.
9905     * @note One state includes geometry, color, map data.
9906     *
9907     * @param transit The transit object.
9908     * @param state_keep Keeping or Non Keeping.
9909     *
9910     * @ingroup Transit
9911     */
9912    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
9913
9914    /**
9915     * Get a value whether the objects states will be reset or not.
9916     *
9917     * @note @p transit can not be NULL
9918     *
9919     * @see elm_transit_objects_final_state_keep_set()
9920     *
9921     * @param transit The transit object.
9922     * @return EINA_TRUE means the states of the objects will be reset.
9923     * If @p transit is NULL, EINA_FALSE is returned
9924     *
9925     * @ingroup Transit
9926     */
9927    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
9928
9929    /**
9930     * Set the event enabled when transit is operating.
9931     *
9932     * If @p enabled is EINA_TRUE, the objects of the transit will receives
9933     * events from mouse and keyboard during the animation.
9934     * @note When you add an object with elm_transit_object_add(), its state from
9935     * evas_object_pass_events_get(obj) is saved, and it is applied when the
9936     * transit ends, if you change this state with evas_object_pass_events_set()
9937     * after adding the object, this state will change again when @p transit stops
9938     * to run.
9939     *
9940     * @param transit The transit object.
9941     * @param enabled Events are received when enabled is @c EINA_TRUE, and
9942     * ignored otherwise.
9943     *
9944     * @ingroup Transit
9945     */
9946    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
9947
9948    /**
9949     * Get the value of event enabled status.
9950     *
9951     * @see elm_transit_event_enabled_set()
9952     *
9953     * @param transit The Transit object
9954     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
9955     * EINA_FALSE is returned
9956     *
9957     * @ingroup Transit
9958     */
9959    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
9960
9961    /**
9962     * Set the user-callback function when the transit is deleted.
9963     *
9964     * @note Using this function twice will overwrite the first function setted.
9965     * @note the @p transit object will be deleted after call @p cb function.
9966     *
9967     * @param transit The transit object.
9968     * @param cb Callback function pointer. This function will be called before
9969     * the deletion of the transit.
9970     * @param data Callback funtion user data. It is the @p op parameter.
9971     *
9972     * @ingroup Transit
9973     */
9974    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
9975
9976    /**
9977     * Set reverse effect automatically.
9978     *
9979     * If auto reverse is setted, after running the effects with the progress
9980     * parameter from 0 to 1, it will call the effecs again with the progress
9981     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
9982     * where the duration was setted with the function elm_transit_add and
9983     * the repeat with the function elm_transit_repeat_times_set().
9984     *
9985     * @param transit The transit object.
9986     * @param reverse EINA_TRUE means the auto_reverse is on.
9987     *
9988     * @ingroup Transit
9989     */
9990    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
9991
9992    /**
9993     * Get if the auto reverse is on.
9994     *
9995     * @see elm_transit_auto_reverse_set()
9996     *
9997     * @param transit The transit object.
9998     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
9999     * EINA_FALSE is returned
10000     *
10001     * @ingroup Transit
10002     */
10003    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10004
10005    /**
10006     * Set the transit repeat count. Effect will be repeated by repeat count.
10007     *
10008     * This function sets the number of repetition the transit will run after
10009     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
10010     * If the @p repeat is a negative number, it will repeat infinite times.
10011     *
10012     * @note If this function is called during the transit execution, the transit
10013     * will run @p repeat times, ignoring the times it already performed.
10014     *
10015     * @param transit The transit object
10016     * @param repeat Repeat count
10017     *
10018     * @ingroup Transit
10019     */
10020    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
10021
10022    /**
10023     * Get the transit repeat count.
10024     *
10025     * @see elm_transit_repeat_times_set()
10026     *
10027     * @param transit The Transit object.
10028     * @return The repeat count. If @p transit is NULL
10029     * 0 is returned
10030     *
10031     * @ingroup Transit
10032     */
10033    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10034
10035    /**
10036     * Set the transit animation acceleration type.
10037     *
10038     * This function sets the tween mode of the transit that can be:
10039     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
10040     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
10041     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
10042     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
10043     *
10044     * @param transit The transit object.
10045     * @param tween_mode The tween type.
10046     *
10047     * @ingroup Transit
10048     */
10049    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
10050
10051    /**
10052     * Get the transit animation acceleration type.
10053     *
10054     * @note @p transit can not be NULL
10055     *
10056     * @param transit The transit object.
10057     * @return The tween type. If @p transit is NULL
10058     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
10059     *
10060     * @ingroup Transit
10061     */
10062    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10063
10064    /**
10065     * Set the transit animation time
10066     *
10067     * @note @p transit can not be NULL
10068     *
10069     * @param transit The transit object.
10070     * @param duration The animation time.
10071     *
10072     * @ingroup Transit
10073     */
10074    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
10075
10076    /**
10077     * Get the transit animation time
10078     *
10079     * @note @p transit can not be NULL
10080     *
10081     * @param transit The transit object.
10082     *
10083     * @return The transit animation time.
10084     *
10085     * @ingroup Transit
10086     */
10087    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10088
10089    /**
10090     * Starts the transition.
10091     * Once this API is called, the transit begins to measure the time.
10092     *
10093     * @note @p transit can not be NULL
10094     *
10095     * @param transit The transit object.
10096     *
10097     * @ingroup Transit
10098     */
10099    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
10100
10101    /**
10102     * Pause/Resume the transition.
10103     *
10104     * If you call elm_transit_go again, the transit will be started from the
10105     * beginning, and will be unpaused.
10106     *
10107     * @note @p transit can not be NULL
10108     *
10109     * @param transit The transit object.
10110     * @param paused Whether the transition should be paused or not.
10111     *
10112     * @ingroup Transit
10113     */
10114    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
10115
10116    /**
10117     * Get the value of paused status.
10118     *
10119     * @see elm_transit_paused_set()
10120     *
10121     * @note @p transit can not be NULL
10122     *
10123     * @param transit The transit object.
10124     * @return EINA_TRUE means transition is paused. If @p transit is NULL
10125     * EINA_FALSE is returned
10126     *
10127     * @ingroup Transit
10128     */
10129    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10130
10131    /**
10132     * Get the time progression of the animation (a double value between 0.0 and 1.0).
10133     *
10134     * The value returned is a fraction (current time / total time). It
10135     * represents the progression position relative to the total.
10136     *
10137     * @note @p transit can not be NULL
10138     *
10139     * @param transit The transit object.
10140     *
10141     * @return The time progression value. If @p transit is NULL
10142     * 0 is returned
10143     *
10144     * @ingroup Transit
10145     */
10146    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
10147
10148    /**
10149     * Makes the chain relationship between two transits.
10150     *
10151     * @note @p transit can not be NULL. Transit would have multiple chain transits.
10152     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
10153     *
10154     * @param transit The transit object.
10155     * @param chain_transit The chain transit object. This transit will be operated
10156     *        after transit is done.
10157     *
10158     * This function adds @p chain_transit transition to a chain after the @p
10159     * transit, and will be started as soon as @p transit ends. See @ref
10160     * transit_example_02_explained for a full example.
10161     *
10162     * @ingroup Transit
10163     */
10164    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
10165
10166    /**
10167     * Cut off the chain relationship between two transits.
10168     *
10169     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
10170     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
10171     *
10172     * @param transit The transit object.
10173     * @param chain_transit The chain transit object.
10174     *
10175     * This function remove the @p chain_transit transition from the @p transit.
10176     *
10177     * @ingroup Transit
10178     */
10179    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
10180
10181    /**
10182     * Get the current chain transit list.
10183     *
10184     * @note @p transit can not be NULL.
10185     *
10186     * @param transit The transit object.
10187     * @return chain transit list.
10188     *
10189     * @ingroup Transit
10190     */
10191    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
10192
10193    /**
10194     * Add the Resizing Effect to Elm_Transit.
10195     *
10196     * @note This API is one of the facades. It creates resizing effect context
10197     * and add it's required APIs to elm_transit_effect_add.
10198     *
10199     * @see elm_transit_effect_add()
10200     *
10201     * @param transit Transit object.
10202     * @param from_w Object width size when effect begins.
10203     * @param from_h Object height size when effect begins.
10204     * @param to_w Object width size when effect ends.
10205     * @param to_h Object height size when effect ends.
10206     * @return Resizing effect context data.
10207     *
10208     * @ingroup Transit
10209     */
10210    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);
10211
10212    /**
10213     * Add the Translation Effect to Elm_Transit.
10214     *
10215     * @note This API is one of the facades. It creates translation effect context
10216     * and add it's required APIs to elm_transit_effect_add.
10217     *
10218     * @see elm_transit_effect_add()
10219     *
10220     * @param transit Transit object.
10221     * @param from_dx X Position variation when effect begins.
10222     * @param from_dy Y Position variation when effect begins.
10223     * @param to_dx X Position variation when effect ends.
10224     * @param to_dy Y Position variation when effect ends.
10225     * @return Translation effect context data.
10226     *
10227     * @ingroup Transit
10228     * @warning It is highly recommended just create a transit with this effect when
10229     * the window that the objects of the transit belongs has already been created.
10230     * This is because this effect needs the geometry information about the objects,
10231     * and if the window was not created yet, it can get a wrong information.
10232     */
10233    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);
10234
10235    /**
10236     * Add the Zoom Effect to Elm_Transit.
10237     *
10238     * @note This API is one of the facades. It creates zoom effect context
10239     * and add it's required APIs to elm_transit_effect_add.
10240     *
10241     * @see elm_transit_effect_add()
10242     *
10243     * @param transit Transit object.
10244     * @param from_rate Scale rate when effect begins (1 is current rate).
10245     * @param to_rate Scale rate when effect ends.
10246     * @return Zoom effect context data.
10247     *
10248     * @ingroup Transit
10249     * @warning It is highly recommended just create a transit with this effect when
10250     * the window that the objects of the transit belongs has already been created.
10251     * This is because this effect needs the geometry information about the objects,
10252     * and if the window was not created yet, it can get a wrong information.
10253     */
10254    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
10255
10256    /**
10257     * Add the Flip Effect to Elm_Transit.
10258     *
10259     * @note This API is one of the facades. It creates flip effect context
10260     * and add it's required APIs to elm_transit_effect_add.
10261     * @note This effect is applied to each pair of objects in the order they are listed
10262     * in the transit list of objects. The first object in the pair will be the
10263     * "front" object and the second will be the "back" object.
10264     *
10265     * @see elm_transit_effect_add()
10266     *
10267     * @param transit Transit object.
10268     * @param axis Flipping Axis(X or Y).
10269     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
10270     * @return Flip effect context data.
10271     *
10272     * @ingroup Transit
10273     * @warning It is highly recommended just create a transit with this effect when
10274     * the window that the objects of the transit belongs has already been created.
10275     * This is because this effect needs the geometry information about the objects,
10276     * and if the window was not created yet, it can get a wrong information.
10277     */
10278    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
10279
10280    /**
10281     * Add the Resizable Flip Effect to Elm_Transit.
10282     *
10283     * @note This API is one of the facades. It creates resizable flip effect context
10284     * and add it's required APIs to elm_transit_effect_add.
10285     * @note This effect is applied to each pair of objects in the order they are listed
10286     * in the transit list of objects. The first object in the pair will be the
10287     * "front" object and the second will be the "back" object.
10288     *
10289     * @see elm_transit_effect_add()
10290     *
10291     * @param transit Transit object.
10292     * @param axis Flipping Axis(X or Y).
10293     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
10294     * @return Resizable flip effect context data.
10295     *
10296     * @ingroup Transit
10297     * @warning It is highly recommended just create a transit with this effect when
10298     * the window that the objects of the transit belongs has already been created.
10299     * This is because this effect needs the geometry information about the objects,
10300     * and if the window was not created yet, it can get a wrong information.
10301     */
10302    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
10303
10304    /**
10305     * Add the Wipe Effect to Elm_Transit.
10306     *
10307     * @note This API is one of the facades. It creates wipe effect context
10308     * and add it's required APIs to elm_transit_effect_add.
10309     *
10310     * @see elm_transit_effect_add()
10311     *
10312     * @param transit Transit object.
10313     * @param type Wipe type. Hide or show.
10314     * @param dir Wipe Direction.
10315     * @return Wipe effect context data.
10316     *
10317     * @ingroup Transit
10318     * @warning It is highly recommended just create a transit with this effect when
10319     * the window that the objects of the transit belongs has already been created.
10320     * This is because this effect needs the geometry information about the objects,
10321     * and if the window was not created yet, it can get a wrong information.
10322     */
10323    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
10324
10325    /**
10326     * Add the Color Effect to Elm_Transit.
10327     *
10328     * @note This API is one of the facades. It creates color effect context
10329     * and add it's required APIs to elm_transit_effect_add.
10330     *
10331     * @see elm_transit_effect_add()
10332     *
10333     * @param transit        Transit object.
10334     * @param  from_r        RGB R when effect begins.
10335     * @param  from_g        RGB G when effect begins.
10336     * @param  from_b        RGB B when effect begins.
10337     * @param  from_a        RGB A when effect begins.
10338     * @param  to_r          RGB R when effect ends.
10339     * @param  to_g          RGB G when effect ends.
10340     * @param  to_b          RGB B when effect ends.
10341     * @param  to_a          RGB A when effect ends.
10342     * @return               Color effect context data.
10343     *
10344     * @ingroup Transit
10345     */
10346    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);
10347
10348    /**
10349     * Add the Fade Effect to Elm_Transit.
10350     *
10351     * @note This API is one of the facades. It creates fade effect context
10352     * and add it's required APIs to elm_transit_effect_add.
10353     * @note This effect is applied to each pair of objects in the order they are listed
10354     * in the transit list of objects. The first object in the pair will be the
10355     * "before" object and the second will be the "after" object.
10356     *
10357     * @see elm_transit_effect_add()
10358     *
10359     * @param transit Transit object.
10360     * @return Fade effect context data.
10361     *
10362     * @ingroup Transit
10363     * @warning It is highly recommended just create a transit with this effect when
10364     * the window that the objects of the transit belongs has already been created.
10365     * This is because this effect needs the color information about the objects,
10366     * and if the window was not created yet, it can get a wrong information.
10367     */
10368    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
10369
10370    /**
10371     * Add the Blend Effect to Elm_Transit.
10372     *
10373     * @note This API is one of the facades. It creates blend effect context
10374     * and add it's required APIs to elm_transit_effect_add.
10375     * @note This effect is applied to each pair of objects in the order they are listed
10376     * in the transit list of objects. The first object in the pair will be the
10377     * "before" object and the second will be the "after" object.
10378     *
10379     * @see elm_transit_effect_add()
10380     *
10381     * @param transit Transit object.
10382     * @return Blend effect context data.
10383     *
10384     * @ingroup Transit
10385     * @warning It is highly recommended just create a transit with this effect when
10386     * the window that the objects of the transit belongs has already been created.
10387     * This is because this effect needs the color information about the objects,
10388     * and if the window was not created yet, it can get a wrong information.
10389     */
10390    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
10391
10392    /**
10393     * Add the Rotation Effect to Elm_Transit.
10394     *
10395     * @note This API is one of the facades. It creates rotation effect context
10396     * and add it's required APIs to elm_transit_effect_add.
10397     *
10398     * @see elm_transit_effect_add()
10399     *
10400     * @param transit Transit object.
10401     * @param from_degree Degree when effect begins.
10402     * @param to_degree Degree when effect is ends.
10403     * @return Rotation effect context data.
10404     *
10405     * @ingroup Transit
10406     * @warning It is highly recommended just create a transit with this effect when
10407     * the window that the objects of the transit belongs has already been created.
10408     * This is because this effect needs the geometry information about the objects,
10409     * and if the window was not created yet, it can get a wrong information.
10410     */
10411    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
10412
10413    /**
10414     * Add the ImageAnimation Effect to Elm_Transit.
10415     *
10416     * @note This API is one of the facades. It creates image animation effect context
10417     * and add it's required APIs to elm_transit_effect_add.
10418     * The @p images parameter is a list images paths. This list and
10419     * its contents will be deleted at the end of the effect by
10420     * elm_transit_effect_image_animation_context_free() function.
10421     *
10422     * Example:
10423     * @code
10424     * char buf[PATH_MAX];
10425     * Eina_List *images = NULL;
10426     * Elm_Transit *transi = elm_transit_add();
10427     *
10428     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
10429     * images = eina_list_append(images, eina_stringshare_add(buf));
10430     *
10431     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
10432     * images = eina_list_append(images, eina_stringshare_add(buf));
10433     * elm_transit_effect_image_animation_add(transi, images);
10434     *
10435     * @endcode
10436     *
10437     * @see elm_transit_effect_add()
10438     *
10439     * @param transit Transit object.
10440     * @param images Eina_List of images file paths. This list and
10441     * its contents will be deleted at the end of the effect by
10442     * elm_transit_effect_image_animation_context_free() function.
10443     * @return Image Animation effect context data.
10444     *
10445     * @ingroup Transit
10446     */
10447    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
10448    /**
10449     * @}
10450     */
10451
10452    /* Store */
10453    typedef struct _Elm_Store                      Elm_Store;
10454    typedef struct _Elm_Store_DBsystem             Elm_Store_DBsystem;
10455    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
10456    typedef struct _Elm_Store_Item                 Elm_Store_Item;
10457    typedef struct _Elm_Store_Item_DBsystem        Elm_Store_Item_DBsystem;
10458    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
10459    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
10460    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
10461    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
10462    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
10463    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
10464    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
10465    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
10466
10467    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
10468    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
10469    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
10470    typedef void      (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
10471    typedef int       (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
10472    typedef void      (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
10473    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
10474
10475    typedef enum
10476      {
10477         ELM_STORE_ITEM_MAPPING_NONE = 0,
10478         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
10479         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
10480         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
10481         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
10482         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
10483         // can add more here as needed by common apps
10484         ELM_STORE_ITEM_MAPPING_LAST
10485      } Elm_Store_Item_Mapping_Type;
10486
10487    struct _Elm_Store_Item_Mapping_Icon
10488      {
10489         // FIXME: allow edje file icons
10490         int                   w, h;
10491         Elm_Icon_Lookup_Order lookup_order;
10492         Eina_Bool             standard_name : 1;
10493         Eina_Bool             no_scale : 1;
10494         Eina_Bool             smooth : 1;
10495         Eina_Bool             scale_up : 1;
10496         Eina_Bool             scale_down : 1;
10497      };
10498
10499    struct _Elm_Store_Item_Mapping_Empty
10500      {
10501         Eina_Bool             dummy;
10502      };
10503
10504    struct _Elm_Store_Item_Mapping_Photo
10505      {
10506         int                   size;
10507      };
10508
10509    struct _Elm_Store_Item_Mapping_Custom
10510      {
10511         Elm_Store_Item_Mapping_Cb func;
10512      };
10513
10514    struct _Elm_Store_Item_Mapping
10515      {
10516         Elm_Store_Item_Mapping_Type     type;
10517         const char                     *part;
10518         int                             offset;
10519         union {
10520              Elm_Store_Item_Mapping_Empty  empty;
10521              Elm_Store_Item_Mapping_Icon   icon;
10522              Elm_Store_Item_Mapping_Photo  photo;
10523              Elm_Store_Item_Mapping_Custom custom;
10524              // add more types here
10525         } details;
10526      };
10527
10528    struct _Elm_Store_Item_Info
10529      {
10530         int                           index;
10531         int                           item_type;
10532         int                           group_index;
10533         Eina_Bool                     rec_item;
10534         int                           pre_group_index;
10535
10536         Elm_Genlist_Item_Class       *item_class;
10537         const Elm_Store_Item_Mapping *mapping;
10538         void                         *data;
10539         char                         *sort_id;
10540      };
10541
10542    struct _Elm_Store_Item_Info_Filesystem
10543      {
10544         Elm_Store_Item_Info  base;
10545         char                *path;
10546      };
10547
10548 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
10549 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
10550
10551    EAPI Elm_Store              *elm_store_dbsystem_new(void);
10552    EAPI void                    elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
10553    EAPI void                    elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
10554    EAPI void                    elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
10555    EAPI void                    elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
10556    EAPI int                     elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
10557    EAPI void                   *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
10558    EAPI void                    elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
10559    EAPI int                     elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
10560    EAPI Elm_Store_Item         *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
10561    EAPI void                    elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
10562    EAPI void                    elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
10563    EAPI void                    elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
10564    EAPI void                    elm_store_free(Elm_Store *st);
10565    EAPI Elm_Store              *elm_store_filesystem_new(void);
10566    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
10567    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
10568    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
10569    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
10570    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
10571    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
10572    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
10573    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
10574    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
10575    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
10576    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
10577    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
10578    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
10579    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
10580    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
10581    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
10582    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
10583
10584    /* SegmentControl */
10585    typedef struct _Elm_Segment_Item Elm_Segment_Item;
10586    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10587    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
10588    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);
10589    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
10590    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
10591    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10592    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
10593    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
10594    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
10595    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
10596    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
10597    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
10598    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
10599    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10600    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
10601    /* smart callbacks called:
10602     * "changed" -when the user clicks on a segment item which is not previously
10603     *            selected and get selected. The event_info parameter is the
10604     *            segment item index.
10605     */
10606
10607    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
10608    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
10609    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
10610    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
10611    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
10612    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
10613    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
10614    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
10615
10616    EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
10617    EAPI void         elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
10618
10619    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
10620    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
10621    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
10622    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
10623    EAPI void elm_video_play(Evas_Object *video);
10624    EAPI void elm_video_pause(Evas_Object *video);
10625    EAPI void elm_video_stop(Evas_Object *video);
10626    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
10627    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
10628    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
10629    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
10630    EAPI double elm_video_audio_level_get(Evas_Object *video);
10631    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
10632    EAPI double elm_video_play_position_get(Evas_Object *video);
10633    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
10634    EAPI double elm_video_play_length_get(Evas_Object *video);
10635    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
10636    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
10637    EAPI const char *elm_video_title_get(Evas_Object *video);
10638
10639    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
10640    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
10641
10642    // FIXME: incomplete - carousel. don't use this until this comment is removed
10643    typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
10644    EAPI Evas_Object       *elm_carousel_add(Evas_Object *parent);
10645    EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
10646    EAPI void               elm_carousel_item_del(Elm_Carousel_Item *item);
10647    EAPI void               elm_carousel_item_select(Elm_Carousel_Item *item);
10648    /* smart callbacks called:
10649     * "clicked" - when the user clicks on a carousel item and becomes selected
10650     */
10651
10652    /* datefield */
10653
10654    typedef enum _Elm_Datefield_ItemType
10655      {
10656         ELM_DATEFIELD_YEAR = 0,
10657         ELM_DATEFIELD_MONTH,
10658         ELM_DATEFIELD_DATE,
10659         ELM_DATEFIELD_HOUR,
10660         ELM_DATEFIELD_MINUTE,
10661         ELM_DATEFIELD_AMPM
10662      } Elm_Datefield_ItemType;
10663
10664    EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
10665    EAPI void         elm_datefield_format_set(Evas_Object *obj, const char *fmt);
10666    EAPI char        *elm_datefield_format_get(const Evas_Object *obj);
10667    EAPI void         elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
10668    EAPI Eina_Bool    elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
10669    EAPI void         elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
10670    EAPI int          elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
10671    EAPI void         elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
10672    EAPI int          elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
10673    EAPI Eina_Bool    elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
10674    EAPI void         elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
10675    EAPI int          elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
10676    EAPI Eina_Bool    elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
10677  
10678    /* smart callbacks called:
10679    * "changed" - when datefield value is changed, this signal is sent.
10680    */
10681
10682 ////////////////////// DEPRECATED ///////////////////////////////////
10683
10684    typedef enum _Elm_Datefield_Layout
10685      {
10686         ELM_DATEFIELD_LAYOUT_TIME,
10687         ELM_DATEFIELD_LAYOUT_DATE,
10688         ELM_DATEFIELD_LAYOUT_DATEANDTIME
10689      } Elm_Datefield_Layout;
10690
10691    EINA_DEPRECATED EAPI void         elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
10692    EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
10693    EINA_DEPRECATED EAPI void         elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
10694    EINA_DEPRECATED EAPI const char  *elm_datefield_date_format_get(const Evas_Object *obj);
10695    EINA_DEPRECATED EAPI void         elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
10696    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_time_mode_get(const Evas_Object *obj);
10697    EINA_DEPRECATED EAPI void         elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
10698    EINA_DEPRECATED EAPI void         elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
10699    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
10700    EINA_DEPRECATED EAPI void         elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
10701    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
10702    EINA_DEPRECATED EAPI void         elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
10703    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);
10704    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
10705 /////////////////////////////////////////////////////////////////////
10706
10707    /* popup */
10708    typedef enum _Elm_Popup_Response
10709      {
10710         ELM_POPUP_RESPONSE_NONE = -1,
10711         ELM_POPUP_RESPONSE_TIMEOUT = -2,
10712         ELM_POPUP_RESPONSE_OK = -3,
10713         ELM_POPUP_RESPONSE_CANCEL = -4,
10714         ELM_POPUP_RESPONSE_CLOSE = -5
10715      } Elm_Popup_Response;
10716
10717    typedef enum _Elm_Popup_Mode
10718      {
10719         ELM_POPUP_TYPE_NONE = 0,
10720         ELM_POPUP_TYPE_ALERT = (1 << 0)
10721      } Elm_Popup_Mode;
10722
10723    typedef enum _Elm_Popup_Orient
10724      {
10725         ELM_POPUP_ORIENT_TOP,
10726         ELM_POPUP_ORIENT_CENTER,
10727         ELM_POPUP_ORIENT_BOTTOM,
10728         ELM_POPUP_ORIENT_LEFT,
10729         ELM_POPUP_ORIENT_RIGHT,
10730         ELM_POPUP_ORIENT_TOP_LEFT,
10731         ELM_POPUP_ORIENT_TOP_RIGHT,
10732         ELM_POPUP_ORIENT_BOTTOM_LEFT,
10733         ELM_POPUP_ORIENT_BOTTOM_RIGHT
10734      } Elm_Popup_Orient;
10735
10736    /* smart callbacks called:
10737     * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
10738     */
10739
10740    EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
10741    EAPI void         elm_popup_desc_set(Evas_Object *obj, const char *text);
10742    EAPI const char  *elm_popup_desc_get(Evas_Object *obj);
10743    EAPI void         elm_popup_title_label_set(Evas_Object *obj, const char *text);
10744    EAPI const char  *elm_popup_title_label_get(Evas_Object *obj);
10745    EAPI void         elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
10746    EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
10747    EAPI void         elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
10748    EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
10749    EAPI void         elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text,  ...);
10750    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, ... );
10751    EAPI void         elm_popup_timeout_set(Evas_Object *obj, double timeout);
10752    EAPI void         elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
10753    EAPI void         elm_popup_response(Evas_Object *obj, int  response_id);
10754    EAPI void         elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
10755    EAPI int          elm_popup_run(Evas_Object *obj);
10756
10757    /* NavigationBar */
10758    #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
10759    #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
10760
10761    typedef enum
10762      {
10763         ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
10764         ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
10765         ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
10766         ELM_NAVIGATIONBAR_BACK_BUTTON
10767      } Elm_Navi_Button_Type;
10768
10769    EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
10770    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);
10771    EAPI void         elm_navigationbar_pop(Evas_Object *obj);
10772    EAPI void         elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
10773    EAPI void         elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
10774    EAPI const char  *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
10775    EAPI void         elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
10776    EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
10777    EAPI Eina_List   *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
10778    EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
10779    EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
10780    EAPI void         elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
10781    EAPI void         elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
10782    EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
10783    EAPI const char  *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
10784    EAPI void         elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
10785    EAPI void         elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
10786    EAPI void         elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
10787    EAPI void         elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
10788    Eina_Bool         elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
10789    EAPI void         elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
10790    EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
10791
10792    /* NavigationBar */
10793    #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
10794    #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
10795
10796    typedef enum
10797      {
10798         ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
10799         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
10800         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
10801         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
10802         ELM_NAVIGATIONBAR_EX_MAX
10803      } Elm_Navi_ex_Button_Type;
10804    typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
10805
10806    EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
10807    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
10808    EAPI void         elm_navigationbar_ex_item_pop(Evas_Object *obj);
10809    EAPI void         elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
10810    EAPI void         elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
10811    EAPI void         elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
10812    EAPI const char  *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
10813    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
10814    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
10815    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);
10816    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
10817    EAPI void         elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
10818    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
10819    EAPI void         elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
10820    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
10821    EAPI const char  *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
10822    EAPI void         elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
10823    EAPI void         elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
10824    EAPI const char  *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
10825    EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
10826    EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
10827    EAPI void         elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
10828    EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
10829    EAPI void         elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
10830    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
10831    EAPI void         elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
10832    EAPI void         elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
10833    Eina_Bool         elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
10834
10835   /* naviframe */
10836   #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
10837   #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
10838   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
10839   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
10840   #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
10841   #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
10842   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
10843   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
10844   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
10845   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
10846
10847   /**
10848     * @defgroup Naviframe Naviframe
10849     *
10850     * @brief Naviframe is a kind of view manager for the applications.
10851     *
10852     * Naviframe provides functions to switch different pages with stack
10853     * mechanism. It means if one page(item) needs to be changed to the new one,
10854     * then naviframe would push the new page to it's internal stack. Of course,
10855     * it can be back to the previous page by popping the top page. Naviframe
10856     * provides some transition effect while the pages are switching (same as
10857     * pager).
10858     *
10859     * Since each item could keep the different styles, users could keep the
10860     * same look & feel for the pages or different styles for the items in it's
10861     * application.
10862     *
10863     * Signals that you can add callback for are:
10864     *
10865     * @li "transition,finished" - When the transition is finished in changing
10866     *     the item
10867     * @li "title,clicked" - User clicked title area
10868     *
10869     * Default contents parts for the naviframe items that you can use for are:
10870     *
10871     * @li "elm.swallow.content" - The main content of the page
10872     * @li "elm.swallow.prev_btn" - The button to go to the previous page
10873     * @li "elm.swallow.next_btn" - The button to go to the next page
10874     *
10875     * Default text parts of naviframe items that you can be used are:
10876     *
10877     * @li "elm.text.title" - The title label in the title area
10878     *
10879     * @ref tutorial_naviframe gives a good overview of the usage of the API.
10880     * @{
10881     */
10882    /**
10883     * @brief Add a new Naviframe object to the parent.
10884     *
10885     * @param parent Parent object
10886     * @return New object or @c NULL, if it cannot be created
10887     */
10888    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10889    /**
10890     * @brief Push a new item to the top of the naviframe stack (and show it).
10891     *
10892     * @param obj The naviframe object
10893     * @param title_label The label in the title area. The name of the title
10894     *        label part is "elm.text.title"
10895     * @param prev_btn The button to go to the previous item. If it is NULL,
10896     *        then naviframe will create a back button automatically. The name of
10897     *        the prev_btn part is "elm.swallow.prev_btn"
10898     * @param next_btn The button to go to the next item. Or It could be just an
10899     *        extra function button. The name of the next_btn part is
10900     *        "elm.swallow.next_btn"
10901     * @param content The main content object. The name of content part is
10902     *        "elm.swallow.content"
10903     * @param item_style The current item style name. @c NULL would be default.
10904     * @return The created item or @c NULL upon failure.
10905     *
10906     * The item pushed becomes one page of the naviframe, this item will be
10907     * deleted when it is popped.
10908     *
10909     * @see also elm_naviframe_item_style_set()
10910     *
10911     * The following styles are available for this item:
10912     * @li @c "default"
10913     */
10914    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);
10915    /**
10916     * @brief Pop an item that is on top of the stack
10917     *
10918     * @param obj The naviframe object
10919     * @return @c NULL or the content object(if the
10920     *         elm_naviframe_content_preserve_on_pop_get is true).
10921     *
10922     * This pops an item that is on the top(visible) of the naviframe, makes it
10923     * disappear, then deletes the item. The item that was underneath it on the
10924     * stack will become visible.
10925     *
10926     * @see also elm_naviframe_content_preserve_on_pop_get()
10927     *
10928     * @ingroup Naviframe
10929     */
10930    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
10931    /**
10932     * @brief Pop the items between the top and the above one on the given item.
10933     *
10934     * @param it The naviframe item
10935     *
10936     * @ingroup Naviframe
10937     */
10938    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
10939    /**
10940    * Promote an item already in the naviframe stack to the top of the stack
10941    *
10942    * @param it The naviframe item
10943    *
10944    * This will take the indicated item and promote it to the top of the stack
10945    * as if it had been pushed there. The item must already be inside the
10946    * naviframe stack to work.
10947    *
10948    */
10949    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
10950    /**
10951     * @brief Delete the given item instantly.
10952     *
10953     * @param it The naviframe item
10954     *
10955     * This just deletes the given item from the naviframe item list instantly.
10956     * So this would not emit any signals for view transitions but just change
10957     * the current view if the given item is a top one.
10958     *
10959     * @ingroup Naviframe
10960     */
10961    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
10962    /**
10963     * @brief preserve the content objects when items are popped.
10964     *
10965     * @param obj The naviframe object
10966     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
10967     *
10968     * @see also elm_naviframe_content_preserve_on_pop_get()
10969     *
10970     * @ingroup Naviframe
10971     */
10972    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
10973    /**
10974     * @brief Get a value whether preserve mode is enabled or not.
10975     *
10976     * @param obj The naviframe object
10977     * @return If @c EINA_TRUE, preserve mode is enabled
10978     *
10979     * @see also elm_naviframe_content_preserve_on_pop_set()
10980     *
10981     * @ingroup Naviframe
10982     */
10983    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10984    /**
10985     * @brief Get a top item on the naviframe stack
10986     *
10987     * @param obj The naviframe object
10988     * @return The top item on the naviframe stack or @c NULL, if the stack is
10989     *         empty
10990     *
10991     * @ingroup Naviframe
10992     */
10993    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10994    /**
10995     * @brief Get a bottom item on the naviframe stack
10996     *
10997     * @param obj The naviframe object
10998     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
10999     *         empty
11000     *
11001     * @ingroup Naviframe
11002     */
11003    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11004    /**
11005     * @brief Set an item style
11006     *
11007     * @param obj The naviframe item
11008     * @param item_style The current item style name. @c NULL would be default
11009     *
11010     * The following styles are available for this item:
11011     * @li @c "default"
11012     *
11013     * @see also elm_naviframe_item_style_get()
11014     *
11015     * @ingroup Naviframe
11016     */
11017    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
11018    /**
11019     * @brief Get an item style
11020     *
11021     * @param obj The naviframe item
11022     * @return The current item style name
11023     *
11024     * @see also elm_naviframe_item_style_set()
11025     *
11026     * @ingroup Naviframe
11027     */
11028    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
11029    /**
11030     * @brief Show/Hide the title area
11031     *
11032     * @param it The naviframe item
11033     * @param visible If @c EINA_TRUE, title area will be visible, hidden
11034     *        otherwise
11035     *
11036     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
11037     *
11038     * @see also elm_naviframe_item_title_visible_get()
11039     *
11040     * @ingroup Naviframe
11041     */
11042    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
11043    /**
11044     * @brief Get a value whether title area is visible or not.
11045     *
11046     * @param it The naviframe item
11047     * @return If @c EINA_TRUE, title area is visible
11048     *
11049     * @see also elm_naviframe_item_title_visible_set()
11050     *
11051     * @ingroup Naviframe
11052     */
11053    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
11054
11055    /**
11056     * @brief Set creating prev button automatically or not
11057     *
11058     * @param obj The naviframe object
11059     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
11060     *        be created internally when you pass the @c NULL to the prev_btn
11061     *        parameter in elm_naviframe_item_push
11062     *
11063     * @see also elm_naviframe_item_push()
11064     */
11065    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
11066    /**
11067     * @brief Get a value whether prev button(back button) will be auto pushed or
11068     *        not.
11069     *
11070     * @param obj The naviframe object
11071     * @return If @c EINA_TRUE, prev button will be auto pushed.
11072     *
11073     * @see also elm_naviframe_item_push()
11074     *           elm_naviframe_prev_btn_auto_pushed_set()
11075     */
11076    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
11077
11078    /* Control Bar */
11079    #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
11080    #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
11081    #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
11082    #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
11083    #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
11084    #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
11085    #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
11086    #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
11087    #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
11088
11089    typedef enum _Elm_Controlbar_Mode_Type
11090      {
11091         ELM_CONTROLBAR_MODE_DEFAULT = 0,
11092         ELM_CONTROLBAR_MODE_TRANSLUCENCE,
11093         ELM_CONTROLBAR_MODE_TRANSPARENCY,
11094         ELM_CONTROLBAR_MODE_LARGE,
11095         ELM_CONTROLBAR_MODE_SMALL,
11096         ELM_CONTROLBAR_MODE_LEFT,
11097         ELM_CONTROLBAR_MODE_RIGHT
11098      } Elm_Controlbar_Mode_Type;
11099
11100    typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
11101    EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
11102    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
11103    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
11104    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);
11105    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);
11106    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);
11107    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);
11108    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);
11109    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);
11110    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
11111    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
11112    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
11113    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
11114    EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
11115    EAPI void         elm_controlbar_item_del(Elm_Controlbar_Item *it);
11116    EAPI void         elm_controlbar_item_select(Elm_Controlbar_Item *it);
11117    EAPI void         elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
11118    EAPI Eina_Bool    elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
11119    EAPI void         elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
11120    EAPI Eina_Bool    elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
11121    EAPI void         elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
11122    EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
11123    EAPI void         elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
11124    EAPI const char  *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
11125    EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
11126    EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
11127    EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
11128    EAPI const Eina_List   *elm_controlbar_items_get(const Evas_Object *obj);
11129    EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
11130    EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
11131    EAPI void         elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
11132    EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
11133    EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
11134    EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
11135    EAPI void         elm_controlbar_mode_set(Evas_Object *obj, int mode);
11136    EAPI void         elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
11137    EAPI void         elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
11138    EAPI void         elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
11139
11140    /* SearchBar */
11141    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
11142    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
11143    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
11144    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
11145    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
11146    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
11147    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
11148    EAPI void         elm_searchbar_clear(Evas_Object *obj);
11149    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
11150
11151    EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
11152    EAPI void         elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
11153    EAPI void         elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
11154    EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
11155
11156    /* NoContents */
11157    EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
11158    EAPI void         elm_nocontents_label_set(Evas_Object *obj, const char *label);
11159    EAPI const char  *elm_nocontents_label_get(const Evas_Object *obj);
11160    EAPI void         elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
11161    EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
11162
11163    /* TickerNoti */
11164    typedef enum
11165      {
11166         ELM_TICKERNOTI_ORIENT_TOP = 0,
11167         ELM_TICKERNOTI_ORIENT_BOTTOM,
11168         ELM_TICKERNOTI_ORIENT_LAST
11169      }  Elm_Tickernoti_Orient;
11170
11171    EAPI Evas_Object              *elm_tickernoti_add (Evas_Object *parent);
11172    EAPI void                      elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
11173    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11174    EAPI int                       elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11175    EAPI void                      elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
11176    EAPI Evas_Object              *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11177    /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
11178    typedef enum
11179     {
11180        ELM_TICKERNOTI_DEFAULT,
11181        ELM_TICKERNOTI_DETAILVIEW
11182     } Elm_Tickernoti_Mode;
11183    EAPI void                      elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11184    EAPI const char               *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
11185    EAPI void                      elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
11186    EAPI Evas_Object              *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11187    EAPI void                      elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11188    EAPI Evas_Object              *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11189    EAPI Evas_Object              *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11190    EAPI void                      elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
11191    EAPI Elm_Tickernoti_Mode       elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11192    EAPI void                      elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
11193    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11194    EAPI void                      elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11195    EAPI const char               *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11196    EAPI void                      elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11197    EAPI Evas_Object              *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11198    EAPI void                      elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
11199    EAPI Evas_Object              *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
11200    /* ############################################################################### */
11201    /*
11202     * Parts which can be used with elm_object_text_part_set() and
11203     * elm_object_text_part_get():
11204     *
11205     * @li NULL/"default" - Operates on tickernoti content-text
11206     *
11207     * Parts which can be used with elm_object_content_part_set() and
11208     * elm_object_content_part_get():
11209     *
11210     * @li "icon" - Operates on tickernoti's icon
11211     * @li "button" - Operates on tickernoti's button
11212     *
11213     * smart callbacks called:
11214     * @li "clicked" - emitted when tickernoti is clicked, except at the
11215     * swallow/button region, if any.
11216     * @li "hide" - emitted when the tickernoti is completely hidden. In case of
11217     * any hide animation, this signal is emitted after the animation.
11218     */
11219
11220    /* colorpalette */
11221    typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
11222
11223    struct _Colorpalette_Color
11224      {
11225         unsigned int r, g, b;
11226      };
11227
11228    EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
11229    EAPI void         elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
11230    EAPI void         elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
11231    /* smart callbacks called:
11232     * "clicked" - when image clicked
11233     */
11234
11235    /* editfield */
11236    EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
11237    EAPI void         elm_editfield_label_set(Evas_Object *obj, const char *label);
11238    EAPI const char  *elm_editfield_label_get(Evas_Object *obj);
11239    EAPI void         elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
11240    EAPI const char  *elm_editfield_guide_text_get(Evas_Object *obj);
11241    EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
11242 //   EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
11243    EAPI void         elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
11244    EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
11245    EAPI void         elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
11246    EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
11247    EAPI void         elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
11248    EAPI Eina_Bool    elm_editfield_entry_single_line_get(Evas_Object *obj);
11249    EAPI void         elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
11250    EAPI Eina_Bool    elm_editfield_eraser_get(Evas_Object *obj);
11251    /* smart callbacks called:
11252     * "clicked" - when an editfield is clicked
11253     * "unfocused" - when an editfield is unfocused
11254     */
11255
11256
11257    /* Sliding Drawer */
11258    typedef enum _Elm_SlidingDrawer_Pos
11259      {
11260         ELM_SLIDINGDRAWER_BOTTOM,
11261         ELM_SLIDINGDRAWER_LEFT,
11262         ELM_SLIDINGDRAWER_RIGHT,
11263         ELM_SLIDINGDRAWER_TOP
11264      } Elm_SlidingDrawer_Pos;
11265
11266    typedef struct _Elm_SlidingDrawer_Drag_Value
11267      {
11268         double x, y;
11269      } Elm_SlidingDrawer_Drag_Value;
11270
11271    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
11272    EINA_DEPRECATED EAPI void         elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
11273    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
11274    EINA_DEPRECATED EAPI void         elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
11275    EINA_DEPRECATED EAPI void         elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw,  double dh);
11276    EINA_DEPRECATED EAPI void         elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
11277
11278    /* multibuttonentry */
11279    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
11280    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
11281    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent);
11282    EAPI const char                *elm_multibuttonentry_label_get(Evas_Object *obj);
11283    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
11284    EAPI Evas_Object               *elm_multibuttonentry_entry_get(Evas_Object *obj);
11285    EAPI const char *               elm_multibuttonentry_guide_text_get(Evas_Object *obj);
11286    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
11287    EAPI int                        elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
11288    EAPI void                       elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
11289    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
11290    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
11291    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
11292    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
11293    EAPI const Eina_List           *elm_multibuttonentry_items_get(Evas_Object *obj);
11294    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
11295    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
11296    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
11297    EAPI void                       elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
11298    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
11299    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
11300    EAPI void                       elm_multibuttonentry_items_del(Evas_Object *obj);
11301    EAPI const char                *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
11302    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
11303    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
11304    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
11305    EAPI void                      *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
11306    EAPI void                       elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
11307    EAPI void                       elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
11308    /* smart callback called:
11309     * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
11310     * "added" - This signal is emitted when a new multibuttonentry item is added.
11311     * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
11312     * "expanded" - This signal is emitted when a multibuttonentry is expanded.
11313     * "contracted" - This signal is emitted when a multibuttonentry is contracted.
11314     * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
11315     * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
11316     * "item,added" - This signal is emitted when a new multibuttonentry item is added.
11317     * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
11318     * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
11319     * "clicked" - This signal is emitted when a multibuttonentry is clicked.
11320     * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
11321     */
11322    /* available styles:
11323     * default
11324     */
11325
11326    /* stackedicon */
11327    typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
11328    EAPI Evas_Object          *elm_stackedicon_add(Evas_Object *parent);
11329    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
11330    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
11331    EAPI void                  elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
11332    EAPI Eina_List            *elm_stackedicon_item_list_get(Evas_Object *obj);
11333    /* smart callback called:
11334     * "expanded" - This signal is emitted when a stackedicon is expanded.
11335     * "clicked" - This signal is emitted when a stackedicon is clicked.
11336     */
11337    /* available styles:
11338     * default
11339     */
11340
11341    /* dialoguegroup */
11342    typedef struct _Dialogue_Item Dialogue_Item;
11343
11344    typedef enum _Elm_Dialoguegourp_Item_Style
11345      {
11346         ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
11347         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
11348         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
11349         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
11350         ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
11351         ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
11352         ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
11353         ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
11354         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
11355         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
11356         ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
11357      } Elm_Dialoguegroup_Item_Style;
11358
11359    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_add(Evas_Object *parent);
11360    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
11361    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
11362    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
11363    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
11364    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove(Dialogue_Item *item);
11365    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove_all(Evas_Object *obj);
11366    EINA_DEPRECATED EAPI void           elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
11367    EINA_DEPRECATED EAPI const char    *elm_dialoguegroup_title_get(Evas_Object *obj);
11368    EINA_DEPRECATED EAPI void           elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
11369    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
11370    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
11371    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
11372    EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style    elm_dialoguegroup_item_style_get(Dialogue_Item *item);
11373    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
11374    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
11375
11376    /* Dayselector */
11377    typedef enum
11378      {
11379         ELM_DAYSELECTOR_SUN,
11380         ELM_DAYSELECTOR_MON,
11381         ELM_DAYSELECTOR_TUE,
11382         ELM_DAYSELECTOR_WED,
11383         ELM_DAYSELECTOR_THU,
11384         ELM_DAYSELECTOR_FRI,
11385         ELM_DAYSELECTOR_SAT
11386      } Elm_DaySelector_Day;
11387
11388    EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
11389    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
11390    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
11391
11392    /* Image Slider */
11393    typedef struct _Imageslider_Item Elm_Imageslider_Item;
11394    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
11395    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11396    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);
11397    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);
11398    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);
11399    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
11400    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11401    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
11402    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
11403    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
11404    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
11405    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
11406    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11407    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11408    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
11409    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
11410 #ifdef __cplusplus
11411 }
11412 #endif
11413
11414 #endif