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